Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
May 30, 2023
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63f3aeb
jpengar/api-readiness-checklist-issue-39
jpengar May 24, 2023
27cb838
Changes to address Rafal's comments
jpengar May 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions documentation/API_documentation/home_devices_qod_readiness_checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# HomeDevicesQoD API Readiness minimum criteria checklist

jpengar marked this conversation as resolved.
Show resolved Hide resolved
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.