...
- A release-candidate API version (extension -rc.n) is a pre-release version of an API which is stabilized and intended to become the next public-release API version.
- The purpose of a pre-release API version is to provide a stable version for implementation and API testing. It shall be used to create the test results and to show it meets the acceptance criteria.
- A release-candidate API version provides the relevant rc items of the release checklist.
A release-candidate API version can only be part of a CAMARA meta-release after approval by the Release Management team.- A release-candidate API version proposed for a meta-release needs to be approved by the Release Management team.
- For a release-candidate API version to be accepted approved for public-release in as part of a given meta-release, it needs to provide all the public-release items on the release checklist.
- Once the release-candidate API version is approved by the Release Management team, the release management process public-release API version is created by the API team for publication as part of a the meta-release, the public-release API version is created.
public-release API version
...
The below table provides guidelines for the initial API versioning exceptions. The semver numbering sequencing does apply for initial API versions. Examples: 0.1.0 < 0.1.1< 0.2.0 < 0.2.0-alpha.m < 0.2.0-rc.n < 0.2.1 < 0.3.0, etc.
| API version | next API version for breaking change | next API version for non-breaking change |
|---|---|---|
| api-0.y.z | api-0.y+1.0 | api-0.y.z+1 |
| api-0.y.z–alpha.m | api-0.y+1.0 | api-0.y.z-alpha.m+1 / api-0.y.z+1 |
| api-0.y.z-rc.n | api-0.y+1.0 | api-0.y.z-rc.n+1 / api-0.y.z+1 |
In the above table, the choice between 2 proposed next API version options is done by the API maintainers based on the estimated stability of the API with respect to the introduced changes.
...
In addition the following are the API version assets that need to be provided to support the release of an API version:
Nr | API version asset | alpha | release-candidate | public-release |
8 | API version tag | Y | Y | Y |
9 | API version release package with release notes & tag | optional | Y | Y |
Examples
The following are examples of the API release asset naming for the various API versions throughout the API version's lifecycle.
...