...
This page was discussed on the RM call of 2024-03-26. Feedback was:
- alpha "-alpha.m" API version shall not be considered as a pre-release, but a not-released.
- release-candidate "-rc.n" extensions
- these extension only internally in CAMARA for release management, but not in externally released APIs, which should only have semver numbers.
- API implementers are recommended to start implementation of an API with the first release-candidate API version in order to give feedback on the API definition. The API definition may change following API implementation feedback on the release-candidate, and result in an updated release-candidate.
- Only fully tested release-candidate API versions can become part of a meta-release.
This page was discussed on the RM call of 2024-04-02:
- Feed back on this page was discussed and partially answered. Further discussions on wiki for resolution next week.
Table of Contents
Table of Contents |
---|
...
- Initial API versions only exist for new APIs. They are API versions with x = 0 (API versions 0.y.z-extension.n)
- An initial API version may exist for several minor version numbers without extensions, but should at some point become mature in an initial alpha API version 0.y.z-alpha.1
- The During initial API version development, the API version in the URL may shall include the major and minor version numbers: v0.y full version number v0.y.z (with dots) to enable testing during rapid development. Applies to initial API versions ONLY Once a first public-release API version has been created (x > 0), no further initial API versions (x = 0) are allowedThe guideline is that the y number is increased with breaking changes, the z number is increased with non-breaking changes. (see alos the exception below).
Exception: an for initial alpha or release-candidate API versions:
A breaking change results in an API version change from 0.y.z-extension.n
to an
API version: 0.y+1.0
. Example: 0.9.0-alpha.m or 0.9.0-rc.n → 0.10.0
- A non-breaking change results in an API version change from 0.y.z-extension.n to an API version. 0.y.z+1
- . Example: 0.9.0-
- alpha.
- m or 0.9.
- 0-rc.n → 0.
- 9.1
- After this, -alpha.m and -rc.n extensions can again be applied throughout the API version development.
- Once a first public-release API version x.y.z has been created (x > 0), no further initial API versions (x = 0) are allowed.
alpha (alpha) API version
...