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.

Sign up for GitHub

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

Jump to bottom

📝 : API documentation #686

Open
abenginerd opened this issue Dec 15, 2021 · 2 comments
Open

📝 : API documentation #686

abenginerd opened this issue Dec 15, 2021 · 2 comments
Labels
📝 documentation Writing docs.

Comments

@abenginerd
Copy link

Is your feature request related to a problem? Please describe.
I see that there are API endpoints for Gaia. Are they all documented anywhere?

Describe the solution you'd like
A Swagger style API documentation for all Gaia APIs.

Describe alternatives you've considered
A api.md explaining the APIs available and their usage.

Additional context
Thanks for the project. This is awesome.
@abenginerd abenginerd added the ✨ enhancement New feature or request label Dec 15, 2021
@juwit juwit changed the title API documentation✨ : issue title 📝 : API documentation Dec 17, 2021
@juwit juwit added 📝 documentation Writing docs. and removed ✨ enhancement New feature or request labels Dec 17, 2021
@juwit
Copy link
Member

juwit commented Dec 17, 2021

Hi,

Thanks for opening this issue.
We'll try to work on API documentation when we have some time.

@AlexDias95
Copy link

Any news?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📝 documentation Writing docs.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@juwit @AlexDias95 @abenginerd