RAMLfications Roadmap - jdiegodcp/ramlfications GitHub Wiki

RAMLfications Roadmaps

Want to know what's going on? Want to help out? Please dive in!

Dev resources

  • "Agile" task board - see what's being worked on actively, the progress of such tasks, and anything that's available to be picked up and worked on
  • Contributors' guidelines - how to contribute to RAMLfications as well as what the labels on issues and the task board mean.

Upcoming Versions

For any issues that are not assigned to one of the above versions, one can assume they will be a part of future releases. Of course, feel free to argue (on the issue themselves) to get them into one of the above releases :).

RAMLfications v0.2.0 Roadmap

Timeline: Release date goal: 12/27/2015 (super optimistic!) 2/21/2016 (probably still super optimistic!)

Issues to fix

Milestone view

  • Issue 14: Top level schemas are not resolved when assigned to resources
  • Issue 43: Support optional properties in resource types (not just methods) and traits
  • Issue 51: Errors aren't collected for multiple of the same item being validated (e.g. multiple protocols)
  • Fix "preserve URI parameter order" that I b0rk3d with the reorg of parsing logic on the new branch
  • Fix "URI parameters missing if not listed in uriParameters property" that I b0rk3d with the reorg of parsing logic on the new branch

Features

  • Issue 2: Parsing & filling in of << parameters >> into individual resources
  • Issue 3: Handle !pluralize and !singularize functions to << parameters >>
  • [DOING] Issue 54: Support for RAML spec version 1.0 - see RAML v1.0 Roadmap for more detail
  • [DOING] PR 52: Add class Node List
  • PR 65: Raise descriptive LoadRAMLError when invalid JSON data is loaded

Cleanup

This is from the object-oriented reorganization of parsing:

  • Tests to fix:

    • v020tests/integration/test_github.py
    • v020tests/integration/test_twitter.py
    • v020tests/unit/test_main.py::test_tree_invalid - this also hangs on my system, but will continue once sent an interuption signal. Must investigate.
    • v020tests/unit/test_nodelist.py::test_nodelist_ramlfications_integration
    • v020tests/unit/test_validate.py
    • v020tests/unit/parser/test_parser.py

  • Unit tests to write:

    • ramlfications/utils/__init__.py
    • ramlfications/utils/_decorators.py
    • ramlfications/utils/common.py
    • ramlfications/utils/parameter.py
    • ramlfications/utils/parser.py
    • ramlfications/parser/__init__.py
    • ramlfications/parser/base.py
    • ramlfications/parser/mixins.py
    • ramlfications/parser/parameters.py
    • ramlfications/parser/types.py

RAMLfications v0.2.x Roadmap

Basically all outstanding issues that haven't been slated for v0.1.9 or v0.2.0:

Issues

  • Issue 49 - Tree prints out multiple of the same endpoint when verbose = 0
  • Issue 50 - with tree, nested resources still contain parent path as opposed to the shell tree command

Features

  • Issue 5 - Construct RAML via Python objects then dump/dumps them to file/string output
  • Issue 15 - Return json & lxml schema objects rather than Python objects

Other

  • Outstanding question/discussion: Issue 67 - Should ResourceNodes include methods?