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.

Sign up for GitHub

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

Jump to bottom

Add @ApiResponse tags in controller classes already implemented (resources) #66

Closed
2 tasks
jenny-alexander opened this issue Nov 28, 2023 · 1 comment · Fixed by #76
Closed
2 tasks

Add @ApiResponse tags in controller classes already implemented (resources) #66

jenny-alexander opened this issue Nov 28, 2023 · 1 comment · Fixed by #76
Assignees
@curtwl
Labels
documentation Improvements or additions to documentation REST API API endpoint creation/modifications Sprint 10

Comments

@jenny-alexander
Copy link
Contributor

Add @Api Response tags to controller classes that are missing this tag.

This is a part of maintaining API endpoints documentation.

  • Resources

All API Creations/Changes:

  • Have you added satisfactory documentation to Swagger (for example: @ApiParam, ApiOperation, @ApiCreatedResponse, @ApiOkResponse, @ApiNotFoundResponse, @ApiBadRequestResponse)?
@jenny-alexander jenny-alexander added documentation Improvements or additions to documentation REST API API endpoint creation/modifications Sprint 10 labels Nov 28, 2023
@jenny-alexander
Copy link
Contributor Author

CGD-66: Add @ApiResponse tags to resources controllers.

@curtwl curtwl mentioned this issue Dec 23, 2023
Merged
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@curtwl curtwl

Labels
documentation Improvements or additions to documentation REST API API endpoint creation/modifications Sprint 10
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Features/resources api responses chingu-x/chingu-dashboard-be
2 participants
@jenny-alexander @curtwl