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 Documentation for RepresentationManagement::V0::OriginalEntitiesController #97792

Closed
6 tasks done
opticbob opened this issue Nov 25, 2024 · 4 comments
Closed
6 tasks done
Assignees
Labels
accredited-representation-management-team Accredited Representation Management team backend mvp Initial version of thing

Comments

@opticbob
Copy link

opticbob commented Nov 25, 2024

Background

The RepresentationManagement::V0::OriginalEntitiesController currently lacks Swagger documentation. This documentation is essential for API consumers to understand the available endpoints, request/response formats, and overall API structure. Adding Swagger documentation will improve the visibility, usability, and maintainability of this controller's API.

Tasks

  • Add Swagger documentation for the endpoint in RepresentationManagement::V0::OriginalEntitiesController.
  • Ensure that request parameters, response formats, and possible error codes are accurately documented.
  • Review and verify that the Swagger documentation renders correctly in the Swagger UI.

Acceptance Criteria

  • Swagger documentation is available for the endpoint in the RepresentationManagement::V0::OriginalEntitiesController.
  • Documentation is complete and accurately reflects the API's request/response structure.
  • The Swagger UI displays the documentation correctly without errors.

How to configure this issue

  1. Label with practice area (backend, frontend,ux, design, research)
  2. Label for MVP work? (mvp)
  3. Add an estimate
  4. Attach an Epic (what body of work is this a part of?)
@opticbob
Copy link
Author

This is in progress and I hope to have it ready for review by EOD tomorrow.

@opticbob
Copy link
Author

Next for this is making it match @jvcAdHoc 's feedback in department-of-veterans-affairs/vets-api#19522, the two PRs are substantially the same. That shouldn't take long.

Whichever PR merges second will require a small touch up so they don't conflict and both properly display their id type (numerical/uuid).

@opticbob
Copy link
Author

opticbob commented Dec 2, 2024

This is now in review and has already had some review suggestions incorporated.

@opticbob
Copy link
Author

opticbob commented Dec 3, 2024

This is approved and merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accredited-representation-management-team Accredited Representation Management team backend mvp Initial version of thing
Projects
None yet
Development

No branches or pull requests

2 participants