Add Swagger Documentation for PdfGenerator2122Controller

[opticbob]

Summary

• This work is behind a feature toggle (flipper): NO
• (Summarize the changes that have been made to the platform): The Swagger documentation for RepresentationManagement::V0::PdfGenerator2122Controller has been added in the rswag format and the existing documentation for the RepresentationManagement::V0::PowerOfAttorneyController has been converted to that same format.
• (If bug, how to reproduce)
• (What is the solution, why is this the solution?)
• (Which team do you work for, does your team own the maintenance of this component?): FAR/ARM
• (If introducing a flipper, what is the success criteria being targeted?)

Related issue(s)

• Add Swagger Documentation for RepresentationManagement::V0::PdfGenerator2122Controller#91500
• Link to previous change of the code/bug (if applicable)
• Link to epic if not included in ticket

Testing done

• New code is covered by unit tests: No, this is a documentation only change.
• Describe what the old behavior was prior to the change
• Describe the steps required to verify your changes are working as expected. Exclusively stating 'Specs run' is NOT acceptable as appropriate testing: With the application up and running you can load http://localhost:3000/representation_management/v0/apidocs in a web browser and see the docs in JSON format. You can also follow the instructions here to load the swagger viewer then point it at that same url to get a more interactive view.
• If this work is behind a flipper:
  • Tests need to be written for both the flipper on and flipper off scenarios. Docs.
  • What is the testing plan for rolling out the feature?

Screenshots

Tall screenshot of entire `RepresentationManagement `apidocs page

What areas of the site does it impact?

(Describe what parts of the site are impacted andifcode touched other areas): It only touches the RepresentationManagement apidocs page.

Acceptance criteria

• I added unit tests and integration tests for each feature (if applicable).
• No error nor warning in the console.
• Events are being sent to the appropriate logging solution
• Documentation has been updated (link to documentation)
• No sensitive information (i.e. PII/credentials/internal URLs/etc.) is captured in logging, hardcoded, or specs
• Feature/bug has a monitor built into Datadog (if applicable)
• If app impacted requires authentication, did you login to a local build and verify all authenticated routes work as expected
• I added a screenshot of the developed feature

[github-actions]

1 Warning

⚠️

This PR changes 428 LoC (not counting whitespace/newlines). In order to ensure each PR receives the proper attention it deserves, we recommend not exceeding 200. Expect some delays getting reviews. File Summary Files modules/representation_management/README.rdoc (+3/-0) modules/representation_management/app/controllers/representation_management/v0/apidocs_controller.rb (+1/-1) modules/representation_management/spec/requests/representation_management/v0/pdf_generator_2122_swagger_spec.rb (+28/-0) modules/representation_management/spec/requests/representation_management/v0/power_of_attorney_swagger_spec.rb (+55/-0) modules/representation_management/spec/support/rswag_config.rb (+207/-0) modules/representation_management/spec/support/swagger_shared_components/v0.rb (+123/-0) rakelib/rswag.rake (+9/-0) spec/swagger_helper.rb (+1/-0) Note: We exclude files matching the following when considering PR size: *.csv, *.json, *.tsv, *.txt, *.md, Gemfile.lock, app/swagger, modules/mobile/docs, spec/fixtures/, spec/support/vcr_cassettes/, modules/mobile/spec/support/vcr_cassettes/, db/seeds, modules/vaos/app/docs, modules/meb_api/app/docs, modules/appeals_api/app/swagger/, *.bru, *.pdf Big PRs are difficult to review, often become stale, and cause delays.

Generated by 🚫 Danger

[holdenhinkle]

Looks good! Just a couple of minor comments.

[holdenhinkle]

I think the description should reflect the broader range of functionalities provided by these APIs. Something like, 'A set of APIs powering the POA Widget, Find a Representative, and Appoint a Representative.' @jvcAdHoc What do you think?

[opticbob]

Sounds good to me!

[opticbob]

[holdenhinkle]

Perhaps change this to 'Generate rswag docs for representation_management' (i.e. remove the word 'the').

[opticbob]

Good catch!

[holdenhinkle]

LGTM!