the OpenAPI specification is split up into 3 files
- Update the one you are manipulating using swagger editor e.g. https://editor.swagger.io/ this helps you avoid syntax errors
- If you update the version, be sure to update all version numbers in all 3 files.
- Go to https://dash.readme.com/ login, access dev.gotom.io
- Click on API Reference (bottom left)
- On "Your API Definitions" double check to which one you want to upload the updated yaml file. Click edit (I twice uploaded the right yaml to the wrong endpoint, so be careful)
- If you cannot see "Drag a file here or click to browse" you maybe, need to select "file" in the popup
- Then drag/upload the yaml file.
- Reload the page to be sure you did not overwrite an existing endpoint with the wrong yaml file. The GUI does not refresh after upload, leading to more confusion so reload the page. (if after a reload there are 2 endpoints with the same name, then you made a mistake)
- If you updated the version number, you now should update it as well in readme.com. Go to versions, click edit version, adjust, and save.
- Write down what was changed in the change log, should be here: /docs/change-log e.g. https://dash.readme.com/project/gotom/v4.4.2/docs/change-log
Visit dev.gotom.io for the API documentation.