Create an API subpage with embedded swagger React component

[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 user (developer)
I want to see the swagger page for an API with a description and additional info
So that I can use endpoints in my own work/project

Acceptance Criteria

Given any CAM API
When a user visits an API subpage
Then a description and any potential additional information should display at the top with the embedded swagger page below

Given a generic API subpage component
When a developer is creating the API docs subpage
Then they should be able to dynamically create as many API subpages as there are APIs

Development Notes

See the wireframes for reference. This component should be generic enough to create any number of subpages without significant effort to create new pages.

Testing

Test Description

Verify the page loads appropriately with the swagger component and responds to mobile and desktop sizes

Assumptions and Pre-Conditions

n/a

Test Data

Given any OpenAPI spec and description text, this component should be able to render the page given props.

Steps to be Executed

1. Supply a description/ any additional info and an OpenAPI spec url to the component
2. Test that the component renders the info appropriately and the swagger page is interactable
3. Verify that the page responds to mobile and desktop sizes

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?