Uninett / Argus

Argus is an alert aggregator for monitoring systems
GNU General Public License v3.0
18 stars 13 forks source link

Replace manual API documentation with OpenAPI #720

Open stveit opened 7 months ago

stveit commented 7 months ago

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

seiji-alyosha commented 6 months ago

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 commented 5 months ago

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.