API Documentation

[cswimr]

Now that the project is open source, we really need to have good api documentation. There's two ways I see of doing this:

• Manually writing documentation for every api endpoint and keeping it up to date (bad idea)
• Using a tool like Swagger UI (Documentation), or something similar, to manage api documentation (recommended)

Link to swaggymania (Documentation)

[smallketchup82]

do we even adhere to the openapi specification??

[cswimr]

good question we should check this

[smallketchup82]

good question we should check this

https://spec.openapis.org/oas/latest.html

[Wingysam]

I believe it does.