search

openannotation / annotator-store

A backend store for the Annotator
http://annotateit.org/
MIT License
177 stars 66 forks source link

Use RFC6570 URI Templates in Hypermedia Responses #66

Open tilgovi opened 11 years ago

tilgovi commented 11 years ago

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

nickstenning commented 11 years ago

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

We serve a v2 API in two different ways:

tilgovi commented 11 years ago

Yep On Oct 30, 2013 9:37 AM, "Nick Stenning" notifications@github.com wrote:

Sounds like a good plan. As you mention in okfn/annotator#275https://github.com/okfn/annotator/issues/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/okfn/annotator-store/issues/66#issuecomment-27408956 .

tilgovi commented 10 years ago

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 commented 10 years ago

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 commented 10 years ago

https://github.com/openannotation/annotator/commit/21161199aa124f9a6ac1bc94e54156abe9676829