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

chore: move open-api docs to open openapi.yaml OR openapi.json #128

Open
rackstar opened this issue Oct 2, 2024 · 0 comments
Open

chore: move open-api docs to open openapi.yaml OR openapi.json #128

rackstar opened this issue Oct 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@rackstar
Copy link
Contributor

rackstar commented Oct 2, 2024

The openapi docs is currently inline and its a little bit hard to read the routes file and know what exactly are the routes available because the openpi docs is so big.

For readability move it to its own file rather than inline.

TODO: point to openapi.yaml / json

 apis: [path.resolve(__dirname, '../routes/*.js')], // files containing annotations as above

https://github.com/NexusMutual/cover-router/blob/master/src/lib/swagger.js

@rackstar rackstar added the documentation Improvements or additions to documentation label Oct 2, 2024
@rackstar rackstar moved this from ⚖ Backlog to TODO in Engineering Tracker 💻 Oct 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: TODO
Development

No branches or pull requests

1 participant