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

Add the OpenAPI specs for the documentation #4

Closed
Grouloo opened this issue Feb 13, 2025 · 0 comments · Fixed by #5
Closed

Add the OpenAPI specs for the documentation #4

Grouloo opened this issue Feb 13, 2025 · 0 comments · Fixed by #5
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Grouloo
Copy link
Collaborator

Grouloo commented Feb 13, 2025

We need to write an OpenAPI-compliant JSON file to configure the swagger endpoint already in place.

ElysiaJS uses a static analyzer to parse the code and find the endpoints, but it cannot read endpoints with a path containing a wildcard (e.g. '/viticulture/vine-varieties*'), so we have to write the documentation for the table endpoints ourselves.

It should not be too much of a problem, as these endpoints all share the same base output. A LLM should be able to generate all of the missing documentation from a snippet and the list of available paths.

https://swagger.io/specification/v2/

https://elysiajs.com/plugins/swagger

@Grouloo Grouloo added the documentation Improvements or additions to documentation label Feb 13, 2025
@Grouloo Grouloo self-assigned this Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
1 participant