...
release milestone | 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 | |
---|---|---|---|---|---|---|---|
New API introduction | wip | vwip | none | none | |||
API devt. | 0.1.0 | v0.1.0 | api-v0.1.0 | optional | pre-release | ||
API devt. major change | 0.2.0 | v0.2.0 | api-v0.2.0 | optional | pre-release | ||
API devt. minor change | 0.2.1 | v0.2.1 | api-v0.2.1 | optional | pre-release | ||
API devt. minor change | 0.2.1.y.0 | -alpha.1 | v0.y2.0alpha11alpha1 | api-v0.2.1-alpha.1 | optional | pre-release | |
API devt. major change | 0.3.0 | v0.y3.0 | api-alpha.1pre-release0.3.0 | optional | pre-release | ||
.... | |||||||
API devt. | 0.2y.0z | -alpha.2 | v0alpha2 | api-0.2.0-alpha.2v0.y.zalpha2 | api-0.2y.0-alpha.2 | mandatory | pre(release |
M3 | 0.2y.0z | -rc.1 | v0rc1 | api-0.2.0-rc.1v0.y.zrc1 | api-0.2y.0z-rc.1 | mandatory | pre-release |
M4 | 0.2y.0z | -rc.2 | v0rc2 | api-0.2.0-rc.2v0.y.0rc2 | api-0.2y.0z-rc.2 | mandatory | pre-release |
M51.0.0 | v1 | api-1.0.0 | v1 | api-1.0.0 | mandatory | latest |
API version x.y.z (x>0) (public-release API updates)
...
release milestone | 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 |
---|---|---|---|---|---|---|
API devt. | 1.1.0 | -alpha.1 | v1alpha1 | api-1.1.0-alpha.1 | optional | pre-release |
API devt. | 1.1.0 | -alpha.2 | v1alpha2 | api-1.1.0-alpha.2api-1.1.0-alpha.2 | mandatory | pre-release |
M3 | 1.1.0 | -rc.1 | v1rc1 | api-1.1.0-rc.1api-1.1.0-rc.1 | mandatory | pre-release |
M4 | 1.1.0 | -rc.2 | v1rc2 | api-1.1.0-rc.2api-1.1.0-rc.2 | mandatory | pre-release |
M5 | 1.1.0 | v1 | api-1.1.0api-1.1.0 | mandatory | latest |
Patch update of API version
release milestone | 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 |
---|---|---|---|---|---|---|
API devt. | 1.1.1 | -alpha.1 | v1alpha1 | api-1.1.1-alpha.1 | optional | pre-release |
API devt. | 1.1.1 | -alpha.2 | v1alpha2 | api-1.1.1-alpha.2api-1.1.1-alpha.2 | mandatory | pre-release |
M3 | 1.1.1 | -rc.1 | v1rc1api-1.1.1-rc.1 | api-1.1.1-rc.1 | mandatory | pre-release |
M4 | 1.1.1 | -rc.2 | v1rc2 | api-1.1.1-rc.2api-1.1.1-rc.2 | mandatory | pre-release |
M5 | 1.1.1 | v1 | api-1.1.1api-1.1.1 | mandatory | latest |
Major update of API version
release milestone | 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 |
---|---|---|---|---|---|---|
API devt. | 2.0.0 | -alpha.1 | v1alpha1v2alpha1 | api-2.0.0-alpha.1 | optional | pre-release |
API devt. | 2.0.0 | -alpha.2 | v1alpha2v2alpha2 | api-2.0.0-alpha.2api-2.0.0-alpha.2 | mandatory | pre-release |
M3 | 2.0.0 | -rc.1 | v1rc1v2rc1 | api-2.0.0-rc.1api-2.0.0-rc.1 | mandatory | pre-release |
M4 | 2.0.0 | -rc.2 | v1rc2v2rc2 | api-2.0.0-rc.2api-2.0.0-rc.2 | mandatory | pre-release |
M5 | 2.0.0 | v1v2 | api-2.0.0api-2.0.0 | mandatory | latest |