API upgrade methodology

For our API versioning, we are relying on semantic versioning. As long as we do not upgrade the major version, any changes we make on the API have to be backward compatible.

If you hit any breaking change during a minor or patch update, feel free to warn us, we will take care to fix the issue.

Otherwise, for major changes, we will warn you 6 months before the change in order to let you prepare your codebase. We will try to make the changes the least annoying and always take backward compatibility for first approach.

We may also maintain old APIs, whenever possible, in order to let you the chance to change your API clients on the fly at your own rhythm.

Easing changes 🔗

A good manner to make changes less difficult to handle is to use one of the SDK generators available for OpenAPI declaration and to create your own SDK for the langage of your choice.

Feel free to try our API generator using TypeScript and though allowing to use typings as a guard to avoid compiling code that uses old API endpoints.

Published on Monday, June 5, 2023 at 1:00:00 PM GMT+2.