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 documentation for API endpoints #84

Open
tomaspalma opened this issue Jul 22, 2024 · 0 comments
Open

Add documentation for API endpoints #84

tomaspalma opened this issue Jul 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@tomaspalma
Copy link
Member

We should have a swagger file with the endpoints, explaining the possible request and response examples.

In the current state we need to look at the code of the backend in order to understand what the endpoints do which is not desirable at all.

We can create an Open API specification file (example here) and then host it on our backend like the example here

@tomaspalma tomaspalma added the documentation Improvements or additions to documentation label Jul 22, 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
None yet
Development

No branches or pull requests

1 participant