camara / original /ApplicationEndpointRegistration /documentation /API_documentation /Application-Endpoint-Registration-API-Readiness-Checklist.md
Application Endpoints Registration API Readiness minimum criteria checklist
Checklist for Application-Endpoint-Registration v0.1.0
| Nr | API release assets | alpha | release-candidate | initial public |
stable public |
Status | Reference information |
|---|---|---|---|---|---|---|---|
| 1 | API definition | M | M | M | M | Y | link |
| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | r3.3 |
| 3 | Guidelines from ICM applied | O | M | M | M | Y | r3.3 |
| 4 | API versioning convention applied | M | M | M | M | Y | |
| 5 | API documentation | M | M | M | M | Y | inline in YAML |
| 6 | User stories | O | O | O | M | Y | link |
| 7 | Basic API test cases & documentation | O | M | M | M | Y | link |
| 8 | Enhanced API test cases & documentation | O | O | O | M | N | |
| 9 | Test result statement | O | O | O | M | N | |
| 10 | API release numbering convention applied | M | M | M | M | Y | |
| 11 | Change log updated | M | M | M | M | Y | link |
| 12 | Previous public release was certified | O | O | O | M | N | |
| 13 | API description (for marketing) | O | O | M | M | Y | Wiki link |