...
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.
API version types in the release process
The following table gives the values of the API version (Info object) and the API version in the URL (servers object) used in the release process of the API.
NOTE: for initial API versions (x=0), the API version in the URL is exceptionally allowed to contain both the MAJOR and the MINOR version numbers (0.y).
| API versions in release process | API version (OAS Info object) | initial (x=0) API version in URL (OAS Servers object) | stable (x>0) API version in URL (OAS Servers object) | API version can be released |
|---|---|---|---|---|
| work-in-progress | wip | vwip | vwip | No |
| alpha | x.y.z-alpha.m | v0.yalpham | vxalpham | Yes (internal) |
| release-candidate | x.y.z-rc.n | v0.yrcn | vxrcn | Yes (internal) |
public-release | x.y.z | v0.y | vx | Yes |
Precedence examples:
- 1.0.0 < 2.0.0 < 2.1.0 < 2.1.1 < 3.0.0.
- 0.1.0 < 0.2.0-alpha.1 < 0.2.0-alpha.2 < 0.2.0-rc.1 < 0.2.0-rc.2 < 0.2.0 (initial public-release)
- 1.0.0 < 1.1.0-alpha.1 < 1.1.0-alpha.2 < 1.1.0-rc.1 < 1.1.0-rc.2 < 1.1.0 (stable public-release)
Releasing an API step by step
...