...
See also Herbert's proposal here: Proposal to establish API Families as Working Groups across API Sub Projects · Issue #7 · camaraproject/ReleaseManagement (github.com)
API release checklist
NOTE: This proposal can be fed back into Commonalities project as needed or moved here.
The following table identifies the items that need to be provided for an API version for a particular release.
...
API version 0.y.z (initial API development and first release)
version | version (OAS file) | API version |
|---|
extension | extension (OAS file) | API version in URL |
|---|
release branch tag | release package name | | (OAS file) | API version tag (GitHub) (api = API name) | API version release package (name = API version tag) (GitHub) | API version release package |
|---|
release 0.1.0 | v0 | main2main2v0alpha12| y.0-alpha.1 |
| pre-release |
| API devt. | 0.2.0 | -alpha.2 | v0alpha2 | api-0.2.0-alpha.2 | api-0.2.0-alpha.2 | pre(release |
| M3 | 0.2.0 | -rc.1 | v0rc1 | api-0.2.0-rc.1 | api-0.2.0-rc.1 | pre-release |
| M4 | 0.2.0 | -rc.2 | v0rc2 | api-0.2.0-rc.2 | api-0.2.0-rc.2 | pre-release |
| M5 | 1.0.0 |
| v1 | api-1.0.0 | api-1.0.0 | latest |
API version x.y.z (x>0) (public-release API updates)
...
Minor 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 branch tag | release package name | | release package tag |
|---|
| API devt. | 1.1.0 | -alpha.1 | v1alpha1 | api-1.1.0-alpha.1 |
|
|
| API devt. | 1.1.0 | -alpha.2 | v1alpha2 | api-1.1.0-alpha.2 | api-1.1.0-alpha.2 | pre-release |
| M3 | 1.1.0 | -rc.1 | v1rc1 | api-1.1.0-rc.1 | api-1.1.0-rc.1 | pre-release |
| M4 | 1.1.0 | -rc.2 | v1rc2 | api-1.1.0-rc.2 | api-1.1.0-rc.2 | pre-release |
| M5 | 1.1.0 |
| v1 | api-1.1.0 | api-1.1.0 | 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 branch tag | release package name | | release package tag |
|---|
| API devt. | 1.1.1 | -alpha.1 | v1alpha1 | api-1.1.1-alpha.1 |
|
|
| API devt. | 1.1.1 | -alpha.2 | v1alpha2 | api-1.1.1-alpha.2 | api-1.1.1-alpha.2 | pre-release |
| M3 | 1.1.1 | -rc.1 | v1rc1 | api-1.1.1-rc.1 | api-1.1.1-rc.1 | pre-release |
| M4 | 1.1.1 | -rc.2 | v1rc2 | api-1.1.1-rc.2 | api-1.1.1-rc.2 | pre-release |
| M5 | 1.1.1 |
| v1 | api-1.1.1 | api-1.1.1 | 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 branch tag | release package name | | release package tag |
|---|
| API devt. | 2.0.0 | -alpha.1 | v1alpha1 | api-2.0.0-alpha.1 |
|
|
| API devt. | 2.0.0 | -alpha.2 | v1alpha2 | api-2.0.0-alpha.2 | api-2.0.0-alpha.2 | pre-release |
| M3 | 2.0.0 | -rc.1 | v1rc1 | api-2.0.0-rc.1 | api-2.0.0-rc.1 | pre-release |
| M4 | 2.0.0 | -rc.2 | v1rc2 | api-2.0.0-rc.2 | api-2.0.0-rc.2 | pre-release |
| M5 | 2.0.0 |
| v1 | api-2.0.0 | api-2.0.0 | latest |