api-docs icon indicating copy to clipboard operation
api-docs copied to clipboard

Adopt openapi spec for API documentation?

Open vadave opened this issue 8 years ago • 1 comments

I was trying to follow along your documentation on contributing, and was surprised when I got to the instructions about submitting an API template. With the widespread adoption of the openapis.org spec I'd recommend using that format for the required submission.

vadave avatar Jan 25 '17 19:01 vadave

This site doesn't host the APIs themselves, it is just a passthrough service and central place to find NASA APIs.

Hence, it is difficult for use to enforce a single way to document all the APIs as we don't necessarily have access to the underlying code. For full API documentation, you should go to the links mentioned for each API.

The new version of this site generates the html about each API from a JSON here: https://github.com/nasa/api-docs/blob/gh-pages/assets/json/apis.json

Leaving this issue up for context for other users.

JustinGOSSES avatar Sep 24 '19 15:09 JustinGOSSES