From 4d34f5bf89f1b62260deebda3759fbd7808032ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Tue, 23 Jul 2024 12:45:22 +0200 Subject: [PATCH 1/5] Update with the new API-Readiness-Checklist.md for Fall24 meta-release --- ...ome-devices-qod-API-Readiness-Checklist.md | 27 +++++++++++++++++++ .../home_devices_qod_readiness_checklist.md | 27 ------------------- 2 files changed, 27 insertions(+), 27 deletions(-) create mode 100644 documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md delete mode 100644 documentation/API_documentation/home_devices_qod_readiness_checklist.md diff --git a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md new file mode 100644 index 0000000..7092e62 --- /dev/null +++ b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md @@ -0,0 +1,27 @@ +# API Readiness Checklist + +Checklist for home-devices-qod 0.4.0-rc.1 in r1.1 + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +| 1 | API definition | M | M | M | M | Y | [code/API_definitions/home_devices_qod.yaml](../../code/API_definitions/home_devices_qod.yaml) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | | +| 4 | API versioning convention applied | M | M | M | M | Y | | +| 5 | API documentation | M | M | M | M | Y | Embedded in [YAML](../../code/API_definitions/home_devices_qod.yaml) | +| 6 | User stories | O | O | O | M | Y | [documentation/API_documentation/home_devices_qod_user_stories.md](./home_devices_qod_user_stories.md) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [code/Test_definitions/home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | Embedded in same [.feature](../../code/Test_definitions/home-devices-qod.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 | | | + +To fill the checklist: +- in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. +- in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release. +- in the Comments column, provide the link to the asset once available, and any other relevant comments. + +Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. + +The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/x/HQBFAQ) \ No newline at end of file diff --git a/documentation/API_documentation/home_devices_qod_readiness_checklist.md b/documentation/API_documentation/home_devices_qod_readiness_checklist.md deleted file mode 100644 index 27fc16b..0000000 --- a/documentation/API_documentation/home_devices_qod_readiness_checklist.md +++ /dev/null @@ -1,27 +0,0 @@ -# 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 | Contributed | [ ] 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: Contributed but not approved yet. - 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. From 57fdf7be320cdf1c9534ad40cbd0536395879d4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Tue, 23 Jul 2024 13:02:56 +0200 Subject: [PATCH 2/5] reduce comments length --- .../home-devices-qod-API-Readiness-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md index 7092e62..8c38fac 100644 --- a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md +++ b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md @@ -4,13 +4,13 @@ Checklist for home-devices-qod 0.4.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | Y | [code/API_definitions/home_devices_qod.yaml](../../code/API_definitions/home_devices_qod.yaml) | +| 1 | API definition | M | M | M | M | Y | [home_devices_qod.yaml](../../code/API_definitions/home_devices_qod.yaml) | | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embedded in [YAML](../../code/API_definitions/home_devices_qod.yaml) | -| 6 | User stories | O | O | O | M | Y | [documentation/API_documentation/home_devices_qod_user_stories.md](./home_devices_qod_user_stories.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [code/Test_definitions/home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.feature) | +| 6 | User stories | O | O | O | M | Y | [home_devices_qod_user_stories.md](./home_devices_qod_user_stories.md) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | Embedded in same [.feature](../../code/Test_definitions/home-devices-qod.feature) | | 9 | Test result statement | O | O | O | M | N | | | 10 | API release numbering convention applied | M | M | M | M | Y | | From b48f7fb88d21d3379db3878a7e07f532d5c585eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Tue, 23 Jul 2024 13:12:25 +0200 Subject: [PATCH 3/5] left-align comments --- .../home-devices-qod-API-Readiness-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md index 8c38fac..e863997 100644 --- a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md +++ b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md @@ -3,15 +3,15 @@ Checklist for home-devices-qod 0.4.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | -|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| | 1 | API definition | M | M | M | M | Y | [home_devices_qod.yaml](../../code/API_definitions/home_devices_qod.yaml) | | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 4 | API versioning convention applied | M | M | M | M | Y | | -| 5 | API documentation | M | M | M | M | Y | Embedded in [YAML](../../code/API_definitions/home_devices_qod.yaml) | +| 5 | API documentation | M | M | M | M | Y | Embedded in [API definition](../../code/API_definitions/home_devices_qod.yaml) | | 6 | User stories | O | O | O | M | Y | [home_devices_qod_user_stories.md](./home_devices_qod_user_stories.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | Embedded in same [.feature](../../code/Test_definitions/home-devices-qod.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.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) | From ad56c228dcbc124f065e4bc7e066b4e89afdfe84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Wed, 24 Jul 2024 08:58:01 +0200 Subject: [PATCH 4/5] Update documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../home-devices-qod-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md index e863997..4095543 100644 --- a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md +++ b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md @@ -14,7 +14,7 @@ Checklist for home-devices-qod 0.4.0-rc.1 in r1.1 | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.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) | +| 11 | Change log updated | M | M | M | M | Y | [CHANGELOG.md](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | | | To fill the checklist: From a24f96922da2a00f33fc85350af3b21f8381ca4f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Pe=C3=B1a=20Garc=C3=ADa-Oliva?= Date: Wed, 24 Jul 2024 10:45:55 +0200 Subject: [PATCH 5/5] Change links to be relative to the project root --- .../home-devices-qod-API-Readiness-Checklist.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md index 4095543..5c3be06 100644 --- a/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md +++ b/documentation/API_documentation/home-devices-qod-API-Readiness-Checklist.md @@ -4,14 +4,14 @@ Checklist for home-devices-qod 0.4.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|----| -| 1 | API definition | M | M | M | M | Y | [home_devices_qod.yaml](../../code/API_definitions/home_devices_qod.yaml) | +| 1 | API definition | M | M | M | M | Y | [home_devices_qod.yaml](/code/API_definitions/home_devices_qod.yaml) | | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | 3 | Guidelines from ICM applied | O | M | M | M | Y | | | 4 | API versioning convention applied | M | M | M | M | Y | | -| 5 | API documentation | M | M | M | M | Y | Embedded in [API definition](../../code/API_definitions/home_devices_qod.yaml) | -| 6 | User stories | O | O | O | M | Y | [home_devices_qod_user_stories.md](./home_devices_qod_user_stories.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [home-devices-qod.feature](../../code/Test_definitions/home-devices-qod.feature) | +| 5 | API documentation | M | M | M | M | Y | Embedded in [API definition](/code/API_definitions/home_devices_qod.yaml) | +| 6 | User stories | O | O | O | M | Y | [home_devices_qod_user_stories.md](/documentation/API_documentation/home_devices_qod_user_stories.md) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [home-devices-qod.feature](/code/Test_definitions/home-devices-qod.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) |