goTom Api Doc (Swagger)

How to update the gotom OpenAPI yaml files for goTom employees

the OpenAPI specification is split up into 3 files

• campaign-api-doc.yaml
• crm-sync-api-doc.yaml
• graph-report-api-doc.yaml

1. Update the one you are manipulating using swagger editor e.g. https://editor.swagger.io/ this helps you avoid syntax errors
2. If you update the version, be sure to update all version numbers in all 3 files.
3. Go to https://dash.readme.com/ login, access dev.gotom.io
4. Watch video walkthrough in gotom main project
5. 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
   • E.g. Admin - Guides - Documentation - Change Log
6. Update postman for PMs for testing

Visit dev.gotom.io for the API documentation.