Skip to content

API Versioning

The Bühler Insights API adopts URI-based versioning. Each major version is distinguished by a unique root path.

For instance:

Each API version is accompanied by its respective OpenAPI specification which can be accessed in the API Reference page.

Semantic Versioning

Our APIs employ semantic versioning, which follows the Major.Minor.Patch format:

  • Major: The major version increments only when there's a breaking change in the API. Introducing a new major version necessitates a new base URL.
  • Minor: Any addition or modification that doesn't break the existing API will result in an increase in the minor version. While these changes are reflected in the OpenAPI specification, they don't alter the base URL. Typically, actions such as adding a new operation, adding an output property, or removing an input property trigger a minor version bump.
  • Patch: Corrections, like bug fixes or other internal changes that don't affect the API's external behavior, will see an increase in the patch version.

Legacy Version Support

We pledge support for versions older than the most recent major release for a minimum of 6 months. However, for optimal performance and features, migrating to the latest major version at the earliest is advised.

{"environments":[],"pdf-download":true}