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

Replace manual API documentation with OpenAPI #720

Open
4 tasks
stveit opened this issue Feb 9, 2024 · 2 comments
Open
4 tasks

Replace manual API documentation with OpenAPI #720

stveit opened this issue Feb 9, 2024 · 2 comments
Labels
API Affects Argus' REST API documentation Improvements or additions to documentation

Comments

@stveit
Copy link
Contributor

stveit commented Feb 9, 2024

API documentation on https://argus-server.readthedocs.io/en/latest/api.html should ideally be defined via OpenAPI instead of manually in a .rst file. This will require a way to hook the generated documentation from OpenAPI into readthedocs

@stveit stveit added documentation Improvements or additions to documentation API Affects Argus' REST API labels Feb 9, 2024
@seiji-alyosha
Copy link

Hey @stveit! Do you still need help with making the API documentation fit OpenAPI specs? I can assist with converting the documentation to a SwaggerUI platform with OpenAPI specs.

@stveit
Copy link
Contributor Author

stveit commented Apr 16, 2024

Hey @stveit! Do you still need help with making the API documentation fit OpenAPI specs? I can assist with converting the documentation to a SwaggerUI platform with OpenAPI specs.

Thank you for offering to help @jaketanis, but we are not looking to go "full OpenAPI" with code generation and such. We are currently generating OpenAPI specs programmatically in Django via drf-spectacular, so our goals are basically to do more of that and integrate it with Sphinx to make the API docs easier to maintain.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Affects Argus' REST API documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants