Update and change policy

The Orquest API is designed to maintain stability and compatibility with previous versions of its different endpoints as much as possible. However, over time, the API may introduce new functionalities to already developed and in-use endpoints.

In this regard, Orquest reserves the right to modify or expand the response structure without prior notice, as long as the changes remain backward compatible. This includes, for example, response overloading, meaning the addition of new fields that were not previously included. Therefore, it is the responsibility of API users to ensure that their implementations are flexible enough to handle these changes without disruptions.

Versioning policy for non-backward-compatible changes

In cases where it is not possible to maintain compatibility with previous functionalities, whether due to design decisions or expansions, Orquest follows a versioning policy for non-backward-compatible changes:

  • When a change in an endpoint’s behavior is introduced, a new version of it in the API will be provided.

  • Previous versions will be marked as deprecated in the documentation for easy identification.

  • New versions will be announced to users, allowing for a planned migration.

  • The documentation will provide updated information and migration strategies.

Marking an endpoint as deprecated doesn’t mean it has been removed or will stop functioning.

If a deprecated endpoint is to be removed, users will be notified well in advance, with an appropriate migration period and support provided during the transition.

Finally, it is recommended to regularly consult the documentation to stay up to date with any API updates or changes, request and response structures, accepted parameters, and any other relevant details.