...
API version type | Purpose & characteristics |
---|---|
work-in-progress (wip) | The purpose of a work-in-progress API version is to indicate that the API is unstable due to one or more PRs being committed, possibly resulting in temporary inconsistencies.
|
alpha (alpha) | The purpose of an alpha API version is to support rapid development of an API and the creation of test implementations for feedback purposes.
|
release-candidate (rc) | The purpose of a release-candidate API version is to allow for (only) bug fixing encountered during further API implementation testing.
|
public-release | The purpose of a public-release API version is that it can be used by organization organizations outside CAMARA in application development.
|
initial public-release | Initial public-release API versions only exist for new APIs.
|
stable public-release | Stable public-release API versions are API versions with x > 0 (x.y.z without version extension). Stable public-release API versions are the ones recommended for use in commercial applications. The user can expect that subsequent API versions will be backward-compatible with the one they are using, unless explicitly announced otherwise. |
...
- First, using wip in the API version, develop your API until it is sufficiently stable to create a first alpha API version 0.1.0-alpha.1
- Create one (or more) alpha API versions to stabilize the API
- Create the first release-candidate API version for the M3 milestone (stable proposed API version for testing)
- Create one (or more) release-candidate API versions between the M3 and the M4 milestone following feedback from testers
- Create the final release-candidate API version for the M4 milestone (stable proposed API version for public-release)
- Finally, create the public-release API version for inclusion for public-release and, possibly, for inclusion in the meta-release
...
The below table gives an overview of the API versioning through the APIs release cycle. The column headers mean the following:
...