Creation of API readiness checklist document (Issue 39) (#40)

* jpengar/api-readiness-checklist-issue-39 * Changes to address Rafal's comments
camaraproject · May 30, 2023 · 3e4ecf9 · 3e4ecf9
1 parent 4d4f84e
commit 3e4ecf9
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/documentation/API_documentation/home_devices_qod_readiness_checklist.md 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)
+
+<br>
+
+| 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)
+
+<br>
+
+  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.