Overview
At project44, we develop and maintain mission-critical APIs that our customers consume in order to use project44 as their source of truth. In order to ensure that the development time and money invested by our customers to integrate with project44 is well spent, project44 has a versioning and release strategy that we publicly advertise and commit to. This document spells out our commitment.
API Versioning & Release Strategy
Versioning
project44 APIs will be versioned via a version number in all URI paths. This strategy provides the consumer of the project44 API with a static contract and a snapshot of behavior that will not change without notice. When a new version of a project44 API is created, the previous version of the API will only be supported for certain amount of time (typically ~24 months after release).
Breaking Changes
As project44’s API and data offerings evolve, there will be a need to modify and change APIs in a way that breaks consumers of the API. These changes are called breaking changes. A breaking change will result in a new version of the API.
Examples of breaking changes include the following:
- removing an entire operation
- removing or renaming a parameter
- removing or renaming a response field
- adding a new required parameter
- making a previously optional parameter required
- changing the type of a parameter or response field
- removing enum values
- adding a new validation rule to an existing parameter
- changing authentication or authorization requirements
Non-Breaking Changes
Non-breaking changes to the project44 API will be added to the latest version of the project44 APIs only. Since these changes are non-breaking, no disruption to existing project44 integrations will occur.
Examples of non-breaking changes include the following:
- adding an operation
- adding an optional parameter
- adding an optional request header
- adding a response field
- adding a response header
- adding enum values
- removing/losing parameter validations
API Release Cadence
Since project44 versions all breaking changes to their API as a new version, all new versions and non-breaking changes will be released after project44 has completed their testing of each new API feature. The developer portal will be updated with release notes to reference any changes.