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

Feature Request: API Documenation from Swagger in Docs Site #117

Open
3 tasks
rosibaj opened this issue Mar 12, 2021 · 0 comments
Open
3 tasks

Feature Request: API Documenation from Swagger in Docs Site #117

rosibaj opened this issue Mar 12, 2021 · 0 comments
Labels
documentation Help docs are needed for this/writing docs needed new-feature Request is a new feature

Comments

@rosibaj
Copy link
Contributor

rosibaj commented Mar 12, 2021

Generally good documenation sites have an api guide.

We have swagger docs for our API's that look and function great: https://song.rdpc-qa.cancercollaboratory.org/swagger-ui.htmlm but these are all custom deployments and not publically available.

We need to make this style of API documentation available. For each piece of software,

  • Have an API section of the documentation
  • Read/translate a copy of the Swagger JSON to explore the API similar to swagger. The JSON can be generated outside of a deployment to be used by the documentation portion of the website.
  • When we want to highlight a specific request, have a module to view the enspoin/response, similar to:
    https://stripe.com/docs/api/customers/retrieve
    image
@rosibaj rosibaj added documentation Help docs are needed for this/writing docs needed new-feature Request is a new feature labels Mar 12, 2021
@rosibaj rosibaj changed the title Feature Request: API Visualization Feature Request: API Documenation from Swagger in Docs Site Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Help docs are needed for this/writing docs needed new-feature Request is a new feature
Projects
None yet
Development

No branches or pull requests

1 participant