Hi Developers,
We are excited to announce an important upcoming change to our API documentation. In our continuous effort to enhance your development experience, we will be migrating our Swagger annotations to OpenAPI.
What This Means
- New JSON File Name: The integration clients will notice a change in the JSON file name from swagger.json to openapi.json. This new file will be aligned with the latest OpenAPI standards.
- Support for Both Versions: To ensure a smooth transition, we will provide the current swagger.json for a period. During this time, the swagger.json will be frozen and served statically, meaning it will not reflect any future changes to the API.
- Action Required: While the API itself remains unchanged, if you rely on tools to generate client code, updating to the newer OpenAPI generator is needed to work with openapi.json. For those who write code manually, please ensure you refer to the new openapi.json for the latest API specifications.
Next Steps
- Watch for Release: Once the OpenAPI version is available, we encourage all developers to start utilizing openapi.json for the most current API documentation.
- Plan Your Transition: Review your current integrations and decide if any updates are needed for your toolset or code base to accommodate these changes.
Stay tuned for release details, and feel free to reach out with any questions. We appreciate your cooperation in adopting these improvements.