Page History

...

• 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 the an API with the first release-candidate API version in order to gove 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 candidiates -candidate API versions can become part of a meta-release.

...

Precedence example:  1.0.0 < 2.0.0 < 2.1.0 < 2.1.1 < 3.0.0.

The CAMARA API guidelines describe the applicable versioning strategy. NOTE: if this proposal is accepted, some updates of the guidelines may be needed.

...

During the API development and release preparation, " alpha " (-alpha) or " release-candidate " (-rc) extensions shall be used to identify intermediate pre-releases versions of an API.  

The notions of alpha and release-candidate API versions, and the related API version extensions, are INTERNAL to the CAMARA project and used only for the development and release management process.

...

Extensions are post-fixed to the API version numbers and separated from it by a hyphen "-". m and n are numbers.

Precedence example: 1.0.0-alpha.1 < 1.0.0 -alpha.2 < 1.1.0-alpha.1 < 1.1.0-alpha.2 < 1.1.0-rc.1 < 1.1.0-rc.2 < 1.1.0 (public-release)

...

servers:
  - url: "{apiRoot}/qod/v2"
    variables:
      apiRoot:
        default: http://localhost:9091
        description: API root

The apiRoot is to be adapted by the implementer of the API endpoint (the API provider).

Once a public-release API version is created and published as part of a meta-release, the API version in the URL of a released API shall ONLY contain the MAJOR digit of the API version, e.g. "v2" in the above example.

The apiRoot is to be adapted by the implementer of the API endpoint (the API provider).

Before API public release, the API definition and endpoint implementation may reflect the extension of the API For alpha and release-candidate API versions, the API version extension shall be included in the URL, but without any hyphen hyphens or dots. 

Example: in the URL the version is v2alpha1 for of an alpha API version 2.y.z-alpha.1, the version in the URL is v2alpha1.

For initial API versions 0.y.z, the second version number may be include in the URL, e.g. v0.y, to This simplifies testing of the API implementations during API development.

...