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
282 stars 201 forks source link

Add Swagger Documentation for RepresentationManagement::V0::PdfGenerator2122Controller #91500

Open opticbob opened 1 month ago

opticbob commented 1 month ago

Background

The RepresentationManagement::V0::PdfGenerator2122Controller 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 week ago

Finished with the 2122 class, converting the existing power of attorney docs to Swagger::Blocks format for this PR.

opticbob commented 1 week ago

After discussions with @jvcAdHoc and @holdenhinkle we're going to move away from the Swagger::Blocks format for this work and use rswag instead. It it already in use within vets-api and supports the latest openapi/swagger specification. It is also frequently updated while Swagger::Blocks was last updated 5 years ago.