department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
284 stars 206 forks source link

Add Swagger Documentation for RepresentationManagement::V0::PdfGenerator2122aController #91501

Open opticbob opened 3 months ago

opticbob commented 3 months ago

Background

The RepresentationManagement::V0::PdfGenerator2122aController 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

Acceptance Criteria


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 commented 1 month ago

Docs are updated but there is lots of duplicated code. Refactoring to reduce duplication is the next step then this should be ready.

This has been moved back to the backlog for now.

opticbob commented 1 week ago

The PR for this ticket is back up to date with the current version of the endpoint. In the morning I'll see what I can do to reduce the code duplication.

opticbob commented 1 week ago

The PR for this ticket is waiting for team review.

opticbob commented 1 week ago

Still waiting for team review.

opticbob commented 1 week ago

Waiting for team review.

opticbob commented 1 week ago

Waiting for team review. First thing Monday morning I'll finish up the other swagger docs PR and I'll ping the team about both at once.

opticbob commented 4 days ago

Waiting for review. I finished up the Accredited Entities for Appoint swagger docs PR and pinged the team about both at once.

opticbob commented 3 days ago

I addressed @jvcAdHoc 's comments and requested an additional review.