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

Question about including extensions #14

Open
blarghmatey opened this issue Jul 3, 2015 · 1 comment
Open

Question about including extensions #14

blarghmatey opened this issue Jul 3, 2015 · 1 comment
Assignees
Labels

Comments

@blarghmatey
Copy link

What is the proper method for signifying inclusion of an extension in this repository within an API? Should the full URL to the extension markdown file be added as a profile link relation? In particular I am interested in taking advantage of the value-types extension and am wondering how best to signify that fact to third party clients of my API.

Thank you for your time.

@mamund
Copy link
Member

mamund commented Apr 29, 2017

@blarghmatey :

sorry for the delayed response

you can add link elements at the top of the document using the "ext" link relation value to indicate which extensions appear in the body:
https://gist.github.com/mamund/655c6c8d6a28939f5a444ed01640049e

keep in mind that this MUST not create a REQUIREMENT for the parser, IOW, all extensions MUST be backward-compatible. existing parsers/clients/etc MUST NOT reject a representation just because it has an extension assertion at the top.

hope this helps.


@mamund mamund self-assigned this Apr 29, 2017
@mamund mamund added the working label Apr 29, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants