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

Move To A Better Format #73

Open
PeterHindes opened this issue Aug 24, 2024 · 0 comments
Open

Move To A Better Format #73

PeterHindes opened this issue Aug 24, 2024 · 0 comments

Comments

@PeterHindes
Copy link

From my peruasl of this repository it seems like the whole documentation is in source/index.html.md which seems like bad form. I propose using the industry standard OpenAPI language: https://www.openapis.org/

In the future this will make it easier to generate tests and ensure our interface remains consistent. This will ultimately allow future frontend rewrites to be done with much more confidence.

I am currently exploring using an llm to translate the current markdown into openapi and will have more to report soon.

For examples of what openapi can do: see this example file and its result from redoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant