Versioning
Our Banking Services APIs follow the semantic versioning scheme where each version consists of
a major, minor and patch version number in the format MAJOR.MINOR.PATCH. Majors describe backwards-incompatible
changes, minors backward-compatible additions and patch backward-compatible bugfixes and non-additive improvements.
We have chosen this versioning strategy to make it easy for our partners to understand the incremental changes of the APIs and to ensure a reliable and predictable environment for integration.
Major versions
A major version will be released if backward-incompatible changes are introduced to an API. Each major will be
expressed through the path of the URL (prefixed with a v):
https://api.banking-services.lunar.app/vXExamples of breaking changes could be:
- Removing an endpoint.
- Changing the format of an endpoint.
- Removing or renaming a field of a request/response.
- Altering the behaviour of an endpoint.
Minor versions
A minor version is going to include additions to an API without breaking existing code. The version number is only going to be visible through the API specs found on the developer portal .
A non-breaking change could be:
- Adding a new field to a response.
- Adding a new optional field to a request.
- Adding a new method to the API.
- Adding a new value to an enum.
Patch versions
A patch version will be used for documentation updates and bugfixes. Like for minor versions the number will only be visible on the specs found on the developer portal.
Sunsetting
New versions of the APIs will periodically be released. Upon release of a new major version (N) we will be supporting major versions of N-1 (marked as deprecated).