Olyn API Versioning

Learn how Olyn communicated and defines versions in order for developers to keep services up-to-date.

🚧

Olyn API in Beta

Olyn API is currently in the Beta stage. API Versioning will be faster and maintenance of older versions limited.

Olyn API versioning is defined at the URL, version changes can be discovered in the changelog.
The formatting used to specify the version is standard. MAJOR.MINOR.PATCH
Stating definition from point 6, 7, 8 from semver.org

  • Patch version Z (x.y.Z | x > 0) MUST be incremented if only backwards-compatible bug fixes are introduced. A bug fix is defined as an internal change that fixes incorrect behaviour.

  • Minor version Y (x.Y.z | x > 0) MUST be incremented if new, backwards compatible functionality is introduced to the public API. It MUST be incremented if any public API functionality is marked as deprecated. It MAY be incremented if substantial new functionality or improvements are introduced within the private code. It MAY include patch-level changes. The Patch version MUST be reset to 0 when the minor version is incremented.

  • Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API. It MAY also include minor and patch-level changes. Patch and minor versions MUST be reset to 0 when the major version is incremented.


Get API Keys

Learn how to handle pagination at Olyn API

Did this page help you?