API Readiness Checklist
January 20, 2026 ยท View on GitHub
Checklist for api-name api-version in rx.y.
| Nr | API release assets | alpha | release-candidate | initial public | stable public | Status | Reference information |
|---|---|---|---|---|---|---|---|
| 1 | API definition | M | M | M | M | relative link | |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Comm. release nr | |
| 3 | Guidelines from ICM applied | O | M | M | M | ICM release nr | |
| 4 | API versioning convention applied | M | M | M | M | ||
| 5 | API documentation | M | M | M | M | in yaml (or relative link) | |
| 6 | User stories | O | O | O | M | relative link | |
| 7 | Basic API test cases & documentation | O | M | M | M | relative link | |
| 8 | Enhanced API test cases & documentation | O | O | O | M | relative link | |
| 9 | Test result statement | O | O | O | M | issue link | |
| 10 | API release numbering convention applied | M | M | M | M | ||
| 11 | Change log updated | M | M | M | M | relative link | |
| 12 | Previous public release was certified | O | O | O | M | comment | |
| 13 | API description (for marketing) | O | O | M | M | wiki link |
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 Reference information column, provide the relative links (from the API repository home folder) to the release asset once available, the applicable release numbers (not versions) of Commonalities and ICM, and any other relevant links or information.
- For the point 12: The Reference information comment shall reference a note (e.g. "see (1)") under the checklist table to be added that states the certified company(s) as can be found on the following link: GSMA Open Gateway Portal (see the MAP for API deployments).
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: see API Readiness Checklist section in the API Release Process.