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

[Documentation]: Document the API using swagger.io #11

Open
SVijayB opened this issue Oct 16, 2022 · 0 comments
Open

[Documentation]: Document the API using swagger.io #11

SVijayB opened this issue Oct 16, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@SVijayB
Copy link
Owner

SVijayB commented Oct 16, 2022

Currently, the API is being documented in the README file and with a simple Html render on the back end.
We ought to use swagger.io and properly document the API if we plan to scale up the project.
It'll also create a much more presentable look for our first review so moving this up in the priority scale.

@SVijayB SVijayB added the documentation Improvements or additions to documentation label Oct 16, 2022
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
None yet
Development

No branches or pull requests

2 participants