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 swagger docs #90

Merged
merged 2 commits into from
May 5, 2024
Merged

Add swagger docs #90

merged 2 commits into from
May 5, 2024

Conversation

mahendrapaipuri
Copy link
Owner

No description provided.

* Use generics to response model which helps to generate correct model in swagger docs

* Add api version in paths

* Define a ownership model to return correct response

* Use swaggo to generate swagger docs

* Add swagger endpoint to interact with swagger docs

* Use 403 instead of 401 when regular user is attempting to access admin endpoint

Signed-off-by: Mahendra Paipuri <[email protected]>
* Include swag init in make build target to regenerate swagger docs before building apps

* Update e2e test outputs with modified 403 responses

Signed-off-by: Mahendra Paipuri <[email protected]>
@mahendrapaipuri mahendrapaipuri added documentation Improvements or additions to documentation enhancement New feature or request labels May 5, 2024
@mahendrapaipuri mahendrapaipuri added this to the v0.1.0 milestone May 5, 2024
@mahendrapaipuri mahendrapaipuri merged commit 17ad0d8 into main May 5, 2024
8 checks passed
@mahendrapaipuri mahendrapaipuri deleted the add_swagger_docs branch May 5, 2024 10:57
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant