Skip to content

Latest commit

 

History

History
9 lines (7 loc) · 536 Bytes

.CONTRIBUTING.md

File metadata and controls

9 lines (7 loc) · 536 Bytes

Adding swagger documentation

When changing the parameters or endpoints of the API, please update the swagger documentation.

  1. Visit the open source editor
  2. Copy and paste the swagger from swagger.json in the docs folder
  3. The editor will ask you to transform the file into yaml, click yes
  4. Make your changes and make sure the swagger is valid. The editor when if it is not
  5. Click on File, then Convert and save as json and update the swagger.json file