API Documentation Format
I noticed you currently use pure Markdown file for the API documentation, would it be okay to switch to
OpenAPI format? There are a couple of reasons I think this would be a good move:
• The format is almost a standard and can be parsed by a lot of tools which makes testing, and spinning mock servers much easier.
• In case the API documentation will be added to the website or published a more structured format, doing that will be a simpler conversion or running it through a tool.
• Easier to contribute to since there are many editors that simplify the process of adding new endpoints and request/response details.
Do you think it will be okay if I switched to this format and sent my PR for the rest of the documentation in OpenAPI format?