Checklist for api-name api-version in rx.y.
| Nr | API release assets | alpha | release-candidate | initial public |
stable public |
Status | Comments |
|---|---|---|---|---|---|---|---|
| 1 | API definition | M | M | M | M | link | |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | ||
| 3 | Guidelines from ICM applied | O | M | M | M | ||
| 4 | API versioning convention applied | M | M | M | M | ||
| 5 | API documentation | M | M | M | M | link | |
| 6 | User stories | O | O | O | M | link | |
| 7 | Basic API test cases & documentation | O | M | M | M | link | |
| 8 | Enhanced API test cases & documentation | O | O | O | M | link | |
| 9 | Test result statement | O | O | O | M | link | |
| 10 | API release numbering convention applied | M | M | M | M | ||
| 11 | Change log updated | M | M | M | M | link | |
| 12 | Previous public release was certified | O | O | O | M |
To fill the checklist:
- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release.
- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.
- in the Comments column, provide the link to the asset once available, and any other relevant comments.
Note: the checklists of a public API version and of its preceding release-candidate API version can be the same.
The documentation for the content of the checklist is here: API Readiness Checklist.