Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Declare particular API elements as stable #51

Open
wtogami opened this issue Jun 23, 2014 · 0 comments
Open

Docs: Declare particular API elements as stable #51

wtogami opened this issue Jun 23, 2014 · 0 comments
Milestone
Baron v2

Comments

@wtogami
Copy link
Collaborator

wtogami commented Jun 23, 2014

The current API routes are a bit messy and likely to change along with future improvements. It would be very messy if 3rd party software becomes reliant on the current API elements.

How should we deal with this?

  • Documentation should declare particular API elements as guaranteed to be unchanging in future versions of Baron?
  • Should the API be versioned within the route path?
  • Should stable API elements be within a marked object within views to differentiate from not stable?
@wtogami wtogami added this to the Baron v2 milestone Jul 2, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Baron v2
Development

No branches or pull requests
1 participant
@wtogami