# API Readiness Checklist

Checklist for device-data-volume v0.1.0 in r1.3

| Nr | API release assets                           | alpha | release-candidate | initial<br>public | stable<br> public | Status |                                                                                        Reference information                                                                                        |
|----|----------------------------------------------|:-----:|:-----------------:|:-----------------:|:-----------------:|:------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 1  | API definition                               |   M   |         M         |         M         |         M         |   Y    |                                                              [device-data-volume.yaml](/code/API_definitions/device-data-volume.yaml)                                                               |
| 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    |                                                                                               in yaml                                                                                               |
| 6  | User stories                                 |   O   |         O         |         O         |         M         |   N    |                                                                                                                                                                                                     |
| 7  | Basic API test cases & documentation         |   O   |         M         |         M         |         M         |   Y    | [checkDataVolume.feature](/code/Test_definitions/device-data-volume-checkDataVolume.feature)<br/>[retrieveDataVolume.feature](/code/Test_definitions/device-data-volume-retrieveDataVolume.feature) |
| 8  | Enhanced API test cases & documentation      |   O   |         O         |         O         |         M         |   Y    | [checkDataVolume.feature](/code/Test_definitions/device-data-volume-checkDataVolume.feature)<br/>[retrieveDataVolume.feature](/code/Test_definitions/device-data-volume-retrieveDataVolume.feature) |
| 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    |                                                                                                                                                                                                     |
| 13 | API description (for marketing)              |   O   |         O         |         M         |         M         |   N    |                                                                  [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/wYFmBQ)                                                                  |