From 3e4ecf91198385013f64c3c5fa5255d7da9e126f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Tue, 30 May 2023 11:49:01 +0200 Subject: [PATCH] Creation of API readiness checklist document (Issue 39) (#40) * jpengar/api-readiness-checklist-issue-39 * Changes to address Rafal's comments --- .../home_devices_qod_readiness_checklist.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 documentation/API_documentation/home_devices_qod_readiness_checklist.md diff --git a/documentation/API_documentation/home_devices_qod_readiness_checklist.md b/documentation/API_documentation/home_devices_qod_readiness_checklist.md new file mode 100644 index 0000000..d85e134 --- /dev/null +++ b/documentation/API_documentation/home_devices_qod_readiness_checklist.md @@ -0,0 +1,27 @@ +# HomeDevicesQoD API Readiness minimum criteria checklist + +Checklist template in Commonalities: [API Readiness minimum criteria checklist](https://github.com/camaraproject/WorkingGroups/blob/main/Commonalities/documentation/API-Readiness-Checklist.md) + +
+ +| No | Deliverables/Criteria | Mandatory | Status (*) | Resolution | +|----|----------------------------------|-----------|----------------------------|----------------------------| +| 1 |API Spec | Y | Approved | [x] Done | +| 2 |API Implementation | N | | | +| 3 |API Documentation | Y | Approved | [x] Done | +| 4 |User Stories | Y | Approved | [x] Done | +| 5 |API test cases | Y | Pending | [ ] Not completed yet | +| 6 |Validated by at least 2 operators | Y | Pending | [ ] Not completed yet | +| 7 |Security review | Y | Approved | [x] Done | + +(*) Status: (Contributed/Approved/Pending/Validated/Partly-Validated) + +
+ + 1. API Spec: [HomeDevicesQoD API Spec](https://github.com/camaraproject/HomeDevicesQoD/blob/main/code/API_definitions/home_devices_qod.yaml) + 2. API Implementation: N/A + 3. API Documentation: Embedded in the API Spec. + 4. User Stories: [HomeDevicesQoD User Stories](https://github.com/camaraproject/HomeDevicesQoD/blob/main/documentation/API_documentation/home_devices_qod_user_stories.md). + 5. API test cases: TBC + 6. Validated by at least 2 operators: TBC + 7. Security review: API spec includes a security scheme section that complies with the AuthN&AuthZ techniques agreed in Commonalities.