# API Readiness Checklist

Checklist for knowledge-base v0.1.0 in r1.2.

| Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
|  1 | API definition                               |   M   |         M         |    M    |    M   |   Y   | [knowledge-base.yaml](/code/API_definitions/knowledge-base.yaml) |
|  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |   Y   | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)  |
|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y   | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3)   |
|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y   |                  |
|  5 | API documentation                            |   M   |         M         |    M    |    M   |   Y   | in yaml |
|  6 | User stories                                 |   O   |         O         |    O    |    M   |   Y   | [for a single API](/documentation/API_documentation/ModelAsAService_knowledge_base_User_Story.md),  [leveraging multiple APIs](/documentation/API_documentation/ModelAsAService_knowledge_base_and_qa_assistant_User_Story.md),|
|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |   Y   | [/code/Test_definitions](/code/Test_definitions) |
|  8 | Enhanced API test cases & documentation      |   O   |         O         |    O    |    M   |   Y   | [/code/Test_definitions](/code/Test_definitions) |
|  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   | [/CHANGELOG.md](/CHANGELOG.md) |
| 12 | Previous public release was certified        |   O   |         O         |    O    |    M   |   N/A   | This is the first public release         |
| 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |   Y   | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/fgLWB) |