CMSgov / bluebutton-web-server

Blue Button API
https://sandbox.bluebutton.cms.gov
Other
40 stars 24 forks source link

jimfuqian/BB2 2821 Add endpoint descriptions to swagger documentation #1227

Closed JFU-NAVA-PBC closed 1 month ago

JFU-NAVA-PBC commented 2 months ago

JIRA Ticket: BB2-2821

What Does This PR Do?

Update openapi.yaml adding SWAGGER Doc endpoint description for all the end points

What Should Reviewers Watch For?

If you're reviewing this PR, please check for these things in particular:

The updated openapi.yaml deployed to TEST: https://test.bluebutton.cms.gov/docs/openapi

here is a screen shot of Patient endpoint with added description:

image

Validation

What Security Implications Does This PR Have?

Please indicate if this PR does any of the following:

Any Migrations?