# API Readiness Checklist

Checklist for API energy-footprint-notification 0.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  | [link](/code/API_definitions/energy_footprint_notification.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  | 0.1.0 |
|  5 | API documentation                            |   M   |         M         |    M    |    M   |   Y  | inline in YAML |
|  6 | User stories                                 |   O   |         O         |    O    |    M   |   Y  | [link](/documentation/API_documentation/EFN_UserStory_UseCase_1.md) |
|  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |   Y  | [Test-EC](/code/Test_definitions/energy-footprint-notification-calculateEnergyConsumption.feature), [Test-CF](/code/Test_definitions/energy-footprint-notification-calculateCarbonFootprint.feature) |
|  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  | r1.3 |
| 11 | Change log updated                           |   M   |         M         |    M    |    M   |   Y  |  |
| 12 | Previous public-release was certified        |   O   |         O         |    O    |    M   |   N  |      |
| 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |   Y  | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/81101707/EnergyFootprintNotification+API+description) |