Skip to main content

Versioning and changelog

This section provides an overview of the versioning schema and presents the currently available versions along with their respective changelogs.

Version numbers are prefixed to every operation path; for example, /1/catalog/status would indicate that version 1 is in use.

Breaking changes​

Any breaking change that we need to introduce to the API interface would result in an increase in the current version number, and we will communicate this change actively and properly beforehand. We strive to minimize the introduction of breaking changes, reserving them only for situations where they are unavoidable. Consequently, you can expect support for a version to extend over longer periods.

Examples of breaking changes include removing fields, dropping support for certain headers, removing a path completely, and significantly altering the behavior of a path or operation..

Non-breaking changes​

Non-breaking or minor changes are introduced to the API versions on the fly, along with bug and security fixes, without increasing any version number. These changes are expected to happen with a certain frequency, and the most important ones are added to the version's changelog below. With some exceptions, non-breaking changes are not communicated beforehand.

Examples of non-breaking changes include adding new fields, adding new paths/operations, performance improvements, bugfixes, fixing security issues, and slightly changing the behavior of a path/operation without changing its intention, meaning, or expected result.

Version 1​

Changelog​

2025-08-29​

  • Added position field to image definitions for explicit display ordering with role-based permissions (only dataContributor and dataValidator roles can set positions) (see more)
  • Added weight=x syntax support in image info field for priority ordering with better semantic clarity, deprecating position=x syntax (backwards compatibility maintained) (see more)

2025-08-11​

  • Added display_order field to attribute definitions (see more)
  • start tracking catalog API changes in this document