Add description to swagger docs for each API

[j-tafoya]

Definition of Ready

• Does this meet the INVEST criteria?
• Does this have a clearly defined user?
• Does this have acceptance criteria?
• Does this have sufficient context for the specific functionality being developed (design, business rules, etc.)

User Story

As a CAM API user
I want to see a description of each API that I am accessing via json or swagger docs
So that I have all the info whether I'm looking at the docs or the json

Acceptance Criteria

Given an API for CAMPD or ECMPS 2.0
When a swagger json doc is created
Then it should include a specific description for that API

Development Notes

The title and description is fed into the swagger doc via this bootstrap.js file in the devops repo. The title and description are set via the manifest-vars.yml files in each API repo or if not set there, then it's set in the app.config.ts file. Within the bootstrap.js file, the custom description and custom css for the description is only set if it is not the production environment. Thus, we may be able to set the description in the manifest-vars file for production for each API and have it populate in the swagger doc if we modify the bootstrap.js file to pull in the description from the config service like it does for the tile etc.

Use the content from the cards in the MVP CAM API Portal

Testing

Test Description

Test whether the swagger json includes the description for production environments and test that the description is visible in the swagger documentation

Assumptions and Pre-Conditions

n/a

Test Data

Description text for each API

Steps to be Executed

fetch the swagger json at the /swagger-json endpoint and load the swagger doc at the /swagger endpoint verify the description is visible in both places for the production environment and not in the beta and test environments

Definition of Done

• Have all Acceptance Criteria been agreed to and validated by the scrum team?
• Has the code been unit tested and peer reviewed?
• Have the functional tests been executed?
• Have all defects been reviewed and dispositioned, resolved, or deferred?
• Is the user story ready to be deployed to the test/staging environments?