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

Swagger api doc generation #46

Open
german1608 opened this issue Jun 15, 2020 · 2 comments
Open

Swagger api doc generation #46

german1608 opened this issue Jun 15, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@german1608
Copy link
Member

Currently, no API docs are published, you'd have to read the code to see what are the endpoints and what do they do.

This adds an /api-doc endpoint to the server that will serve an openapi schema for all of our endpoints automatically.

It might be useful as well to take that yaml/json from that endpoint and generate some documentation in markdown/html and check-them on the repository or somewhere else.

@german1608 german1608 added the enhancement New feature or request label Jun 15, 2020
@davideluque
Copy link
Member

Sounds great!

We have written documentation on our Confluence as well, we can use it for descriptions, etc. We should look into integrating these docs within the /api-doc endpoint.

@davideluque
Copy link
Member

Sounds great!

We have written documentation on our Confluence as well, we can use it for descriptions, etc. We should look into integrating these docs within the /api-doc endpoint.

Also, some link to our academic research perhaps? I am thinking that we could add a README.md like this, that gives information about the org.

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

No branches or pull requests

2 participants