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.

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

Use RFC6570 URI Templates in Hypermedia Responses #66

Open
tilgovi opened this issue Oct 26, 2013 · 5 comments
Open

Use RFC6570 URI Templates in Hypermedia Responses #66

tilgovi opened this issue Oct 26, 2013 · 5 comments

Comments

@tilgovi
Copy link
Member

tilgovi commented Oct 26, 2013

http://tools.ietf.org/html/rfc6570

@nickstenning
Copy link
Member

Sounds like a good plan. As you mention in openannotation/annotator#275, this will break backwards compatibility. I propose the following.

We serve a v2 API in two different ways:

  • at /api/v2
  • at /api, in response to an appropriate "Accept" header (e.g. application/vnd.annotator.v2+json)

@tilgovi
Copy link
Member Author

tilgovi commented Oct 30, 2013

Yep
On Oct 30, 2013 9:37 AM, "Nick Stenning" [email protected] wrote:

Sounds like a good plan. As you mention in openannotation/annotator#275openannotation/annotator#275,
this will break backwards compatibility. I propose the following.

We serve a v2 API in two different ways:

  • at /api/v2
  • at /api, in response to an appropriate "Accept" header (e.g.
    application/vnd.annotator.v2+json)


Reply to this email directly or view it on GitHubhttps://github.com//issues/66#issuecomment-27408956
.

@tilgovi
Copy link
Member Author

tilgovi commented Oct 3, 2014

Just to chime in here, I think we should delay this until we release annotator v2 and do a simultaneous release where we just bump the version and do this without any compat code.

@tilgovi
Copy link
Member Author

tilgovi commented Oct 3, 2014

I think there are probably few people, if any, beyond Hypothes.is who are using the response to this endpoint to bootstrap their Store plugin.

@nickstenning
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants