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

Self-documentation and discovery API for API? #192

Open
seandavi opened this issue Apr 7, 2017 · 3 comments
Open

Self-documentation and discovery API for API? #192

seandavi opened this issue Apr 7, 2017 · 3 comments

Comments

@seandavi
Copy link

seandavi commented Apr 7, 2017

The new additions to the API are very welcome--thanks! How would one discover programmatically the available endpoints, their possible arguments/parameters, etc.?

@wwysoc2
Copy link
Contributor

wwysoc2 commented Apr 7, 2017

Hi Sean,
The endpoints aren't programmatically discoverable, but the possible arguments and parameters can be accessed by looking at:

https://api.gdc.cancer.gov/<endpoint>/_mapping

Note that the 'analysis' endpoints do not have a _mapping option.

@seandavi
Copy link
Author

seandavi commented Apr 8, 2017

Thanks, @wwysoc2. Could I suggest this as a feature request, then? Standards such as:

https://www.openapis.org/

are pretty relevant for such tasks, as the YAML description leads to a highly documented and discoverable API, complete with tooling on the client and server sides. I am not suggesting this one specifically as an implementation, but more as a concept.

@wwysoc2
Copy link
Contributor

wwysoc2 commented Apr 11, 2017

@seandavi Thanks for the input! I'll put in a feature request for this.

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