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 missing openapi query & response specifications to schemas #93

Open
andrew-wang0 opened this issue Jan 24, 2025 · 1 comment
Open
Assignees

Comments

@andrew-wang0
Copy link
Member

andrew-wang0 commented Jan 24, 2025

Extension of #79

Currently, many keys in our schemas have no good examples or descriptions.

For example, the below is missing examples
Image

And the below is missing descriptions
Image

Add openapi metadata to all routes with missing examples and descriptions to help users understand the query params and response schemas.

See the LARC endpoint for an example of a fully documented endpoint using openapi.

@rsahyoun
Copy link
Contributor

I can take this task if that works for you.

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

2 participants