...
The following table explains each of the criteria to be respected by an API Sub-project to be classified as Sandbox or Incubating.
Nr | API Sub-project classification criteria | Explanation |
Linting rules enabled | The linting rules provided by Commonalities that are successfully executed against the OAS API definition file. The output report of the linting shall be provided. | |
Maintainers (from at least 3 distinct companies) | This needs to be checked and confirmed by the API Sub-project team in the API Sub-project home/MAINTAINERS.md file. | |
Codeowners (from at least 3 distinct companies) | This needs to be checked and confirmed by the API Sub-project team in the API Sub-project home/CODEOWNERS file. |
?
API release numbering conventions
This is verified using the information on the release tracker page.
Protected branches enabled
Do we still need this ? As there are no more release publication branches, this would only apply to maintenance release branches ?
Protected branches enabled | Required for incubated API Sub-Projects | |
User stories | Required for incubated API Sub-projects | |
? | Release-candidate API version tested in at least 2 operator implementations | References to at least 2 operator implementations of the API are provided. In which form shall this information be provided ? Links to websites could be added to the API release tracker. |
? | initial public-release API version certified and launched in at least 2 operators is needed to become stable | References to at least 2 certifications and at least 2 commercial operator implementations of the API are provided. In which form shall this information be provided ? Links to websites could be added to the API release tracker. |
The following table is the API readiness checklist of the assets that need to be provided for the release of an given API version.
Nr | API |
alpha
release-candidate
public-release
initial
Sub-project classification criteria | API Sub-project | ||
Sandbox | Incubated | ||
Linting rules enabled | Y | Y | |
Y
Y
Maintainers doc (from at least 3 distinct companies) |
Y
Y | Y | ||
Codeowners doc (from at least 3 distinct companies) | Y | Y |
Y
Y
? | API release numbering conventions followed |
Y
Y | Y | ||
Protected branches enabled | Y | Y |
Y
Y
? | Release-candidate API version tested in at least 2 operator implementations |
N
N
Y | Y |
? |
At least one public-release API version |
N
N
N
in a Sandbox has to be launched by n operator in m markets in production is required to become Incubated | N/A | M |