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

Include API specification #6

Open
nichtich opened this issue May 23, 2014 · 3 comments
Open

Include API specification #6

nichtich opened this issue May 23, 2014 · 3 comments

Comments

@nichtich
Copy link

The specification could be an RFC, W3C recommendation or any other kind of document. Two APIs with same specification can be accessed the same way (e.g. with the same client library). The human readable documentation of an API, however, is most likely unique per API because it includes branding and other information specific to the particular API instance.

@kinlane
Copy link
Contributor

kinlane commented May 24, 2014

An RFC, W3C or even a media type is definitely on our roadmap as we consider the best way to solidify this in people's minds.

Our goal with the link references for each API will allow for referencing of any human or machine readable building blocks including branding, tos, docs, etc. etc.

@kinlane
Copy link
Contributor

kinlane commented May 24, 2014

Thanks for your feedback!

@njyx
Copy link
Contributor

njyx commented Jun 11, 2014

I think for now as close as we can get is to point to the machine readable specifications in Swagger, Blueprint, RAML etc. unfortunately those are still tied to the instance of the API and not the "class". I'm not sure we can do much about this until a lot of generic API specifications are out there (e.g. in API Commons) and referencable.

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

No branches or pull requests

3 participants