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 Parameters to Swagger Docs #31

Open
razznblue opened this issue Aug 11, 2023 · 0 comments
Open

Add Parameters to Swagger Docs #31

razznblue opened this issue Aug 11, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@razznblue
Copy link
Member

razznblue commented Aug 11, 2023

The API supports query parameters in the request url but they are not documented yet in the swagger docs. This would involve modifying the swagger config to include available query parameters for use. Currently, we use swagger-autogen to automatically generate swagger docs.

The swagger config file would be a good place to start researching, as well as the swagger-auto-gen documentation.

@razznblue razznblue added good first issue Good for newcomers documentation Improvements or additions to documentation labels Aug 11, 2023
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant