Ft8 - Add OpenAPI Docs for Endpoints - Githubissues

math-dojo / user-account-service

Microservice for managing the users of the math-dojo platform

1 stars 0 forks source link

Ft8 - Add OpenAPI Docs for Endpoints #12

Closed noce2 closed 4 years ago

noce2 commented 4 years ago

Purpose

Adds documentation for endpoints that will be published by the user account service

Does this introduce a breaking change?

[ ] Yes
[X] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[X] Documentation content changes
[ ] Other... Please describe:

How to Test

Load the definition in Swagger Editor: https://editor.swagger.io/

Test the code

Copy link to raw openapi.yaml from Github in load in the Swagger Editor

What to Check

Verify that the following are valid

It should render correctly with no errors
It should contain 4 endpoints

Other Information