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

Add links to open API spec in ReDoc and Swagger Editor #15

Closed
gregory1g opened this issue Apr 11, 2024 · 4 comments · Fixed by #21
Closed

Add links to open API spec in ReDoc and Swagger Editor #15

gregory1g opened this issue Apr 11, 2024 · 4 comments · Fixed by #21
Labels
enhancement New feature or request

Comments

@gregory1g
Copy link
Collaborator

Problem description
To view an API in a Swagger Editor one need to do few manual steps (every time).

Possible evolution
Add direct links to view the API specification in ReDoc and Swagger Editor in the main read.me like this is done for other APIs (for example https://github.com/camaraproject/SimSwap)

@gregory1g gregory1g added the enhancement New feature or request label Apr 11, 2024
@sachinvodafone
Copy link
Collaborator

It appears that almost all Camera APIs follow a standard template that includes ReDoc and Swagger Editor to open specifications. Therefore, it would be beneficial to use the same approach.

@jgarciahospital
Copy link
Collaborator

AFAIK, only released APIs are including such schema. In any case, for simplicity while reviewing the code, I'll open a PR to include the link to the WIP yaml.

jgarciahospital added a commit that referenced this issue Apr 22, 2024
As per #15 links have been added to readme for fast access to editors of the WIP version
@gregory1g
Copy link
Collaborator Author

Having these links is handy independent on "released state": in the main branch - to the API version which is currently in main branch (which is mostly always a WIP), in the release branch - to the released version.

@jgarciahospital
Copy link
Collaborator

Agreed and solved in #19

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants