...
An API version tag is a GitHub tag placed on the main or a selected maintenance branch to allow locating the corresponding API version in the repository.
...
An API version release package is created using the GitHub release mechanism. It consists in a zip file that has a snapshot of the API Sub-project repository with the content located using indicated by the API version's tag.
Releasing API versions
...
The following section describe the details on naming, release assets, and the steps to produce a public-release API version as part of a meta-release.
API version release assets & naming conventions
For a given API version, its release consists in creating the set of API version release assets with naming as indicated in the below table.
| API version type | API version (OAS file) | API version extension (OAS file) | API version in URL (OAS file) | API version tag (GitHub) (api = API name) | API version release package (name = API version tag) (GitHub) | API version release package tag |
|---|---|---|---|---|---|---|
| initial (x=0) | 0.y.z | none -alpha.m -rc.n | v0.y .z (exception) v0alpham v0rcn | api-0.y.z api-0.y.z-alpha.m api-0.y.z-rc.n | optional | optional [ pre-release ] |
| alpha | x.y.z | -alpha.m | vxalpham | api-x.y.z-alpha.m | optional | optional [ pre-release ] |
| release-candidate | x.y.z | -rc.n | vxrcn | api-x.y.z-rc.n | mandatory | pre-release |
| public-release | x.y.z | none | vx | api-x.y.z | mandatory | latest |
| work-in-progress | wip | N/A | vwip | N/A | N/A | N/A |
...