From ba576554ef206e7e0002229ec1c39c487ace044d Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 20 Jun 2024 14:07:59 +0200 Subject: [PATCH 1/6] New readiness checklist According to: https://github.com/camaraproject/CallForwardingSignal/issues/34 --- .../CFS-API-Readiness-Checklist.md | 33 +++++++++++-------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/documentation/API_documentation/CFS-API-Readiness-Checklist.md b/documentation/API_documentation/CFS-API-Readiness-Checklist.md index 36b1363..719df62 100644 --- a/documentation/API_documentation/CFS-API-Readiness-Checklist.md +++ b/documentation/API_documentation/CFS-API-Readiness-Checklist.md @@ -1,13 +1,20 @@ -# CFS API Readiness minimum criteria checklist - -
- -| No | Deliverables/Criteria | Mandatory | Status (Contributed/Approved/Pending/Validated/Partly-Validated)| -|----|----------------------------------|-----------|---------------------------- -| 1 |API Spec | Y | Contributed | -| 2 |API Implementation | N | -- | -| 3 |API Documentation | Y | Contributed | -| 4 |User Stories | Y | Approved | -| 5 |API test cases | Y | Pending | -| 6 |Validated by atleast 2 operators | Y | Pending | -| 7 |Security review | Y | Pending | + +# API Readiness Checklist + +Checklist for CFS API wip + +| Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +| 1 | API definition | M | M | M | M | Y | | +| 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 | | +| 6 | User stories | O | O | O | M | Y | | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | | +| 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 | N | | +| 11 | Change log updated | M | M | M | M | N | | +| 12 | Previous public-release was certified | O | O | O | M | N | | + From e6ca9e6cdd80e034b970abfa6dea5d76f6e2e089 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 18 Jul 2024 09:33:42 +0200 Subject: [PATCH 2/6] Update CFS-API-Readiness-Checklist.md - not considering the use cases that are mandatory for the Alpha and still under "refactoring" - considering merged the changelog PR: https://github.com/camaraproject/CallForwardingSignal/pull/58 --- .../API_documentation/CFS-API-Readiness-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/CFS-API-Readiness-Checklist.md b/documentation/API_documentation/CFS-API-Readiness-Checklist.md index 719df62..ebeaf8c 100644 --- a/documentation/API_documentation/CFS-API-Readiness-Checklist.md +++ b/documentation/API_documentation/CFS-API-Readiness-Checklist.md @@ -11,10 +11,10 @@ Checklist for CFS API wip | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | | | 6 | User stories | O | O | O | M | Y | | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | | +| 7 | Basic API test cases & documentation | O | M | M | M | N | | | 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 | N | | -| 11 | Change log updated | M | M | M | M | N | | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | | | 12 | Previous public-release was certified | O | O | O | M | N | | From 8b85b8f6c0365923f253ee7a7e56805657b04569 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 18 Jul 2024 10:23:33 +0200 Subject: [PATCH 3/6] Update CFS-API-Readiness-Checklist.md addressing: https://github.com/camaraproject/CallForwardingSignal/pull/43#issuecomment-2235900981 --- .../API_documentation/CFS-API-Readiness-Checklist.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/CFS-API-Readiness-Checklist.md b/documentation/API_documentation/CFS-API-Readiness-Checklist.md index ebeaf8c..31bf4ed 100644 --- a/documentation/API_documentation/CFS-API-Readiness-Checklist.md +++ b/documentation/API_documentation/CFS-API-Readiness-Checklist.md @@ -5,16 +5,16 @@ Checklist for CFS API wip | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | Y | | +| 1 | API definition | M | M | M | M | Y | /code/API_definitions/Call_Forwarding_Signal.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 | | +| 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | | -| 7 | Basic API test cases & documentation | O | M | M | M | N | | +| 7 | Basic API test cases & documentation | O | M | M | M | N | /documentation/API_documentation/CFS_UserStory_UseCase-1.md | | 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 | | -| 11 | Change log updated | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | /CHANGELOG.md | | 12 | Previous public-release was certified | O | O | O | M | N | | From 115158687e6b784e1083b2988d28563ff3cf02b7 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 18 Jul 2024 14:07:48 +0200 Subject: [PATCH 4/6] Update documentation/API_documentation/CFS-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- documentation/API_documentation/CFS-API-Readiness-Checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/CFS-API-Readiness-Checklist.md b/documentation/API_documentation/CFS-API-Readiness-Checklist.md index 31bf4ed..78c5217 100644 --- a/documentation/API_documentation/CFS-API-Readiness-Checklist.md +++ b/documentation/API_documentation/CFS-API-Readiness-Checklist.md @@ -1,7 +1,8 @@ # API Readiness Checklist -Checklist for CFS API wip +Checklist for API call-forwarding-signal v0.2.0-rc.1 in r1.1 + | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From baac4f040ac5a7ca5b5037e102be6786d4914af4 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 18 Jul 2024 15:13:46 +0200 Subject: [PATCH 5/6] Update CFS-API-Readiness-Checklist.md further "Comments" --- .../API_documentation/CFS-API-Readiness-Checklist.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/CFS-API-Readiness-Checklist.md b/documentation/API_documentation/CFS-API-Readiness-Checklist.md index 78c5217..972565b 100644 --- a/documentation/API_documentation/CFS-API-Readiness-Checklist.md +++ b/documentation/API_documentation/CFS-API-Readiness-Checklist.md @@ -9,13 +9,13 @@ Checklist for API call-forwarding-signal v0.2.0-rc.1 in r1.1 | 1 | API definition | M | M | M | M | Y | /code/API_definitions/Call_Forwarding_Signal.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 | | +| 4 | API versioning convention applied | M | M | M | M | Y | v0.2.0-rc.1 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | -| 6 | User stories | O | O | O | M | Y | | -| 7 | Basic API test cases & documentation | O | M | M | M | N | /documentation/API_documentation/CFS_UserStory_UseCase-1.md | +| 6 | User stories | O | O | O | M | Y | /documentation/API_documentation/CFS_UserStory_UseCase-1.md | +| 7 | Basic API test cases & documentation | O | M | M | M | N | code/Test_definitions/call-forwarding-signal-every-forwarding.feature, code/Test_definitions/call-forwarding-signal-unconditional.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 | | +| 10 | API release numbering convention applied | M | M | M | M | Y | r1.1 | | 11 | Change log updated | M | M | M | M | Y | /CHANGELOG.md | | 12 | Previous public-release was certified | O | O | O | M | N | | From 2fca859ce01b8de38b00738a614ec6aec322a9e6 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Thu, 18 Jul 2024 22:47:55 +0200 Subject: [PATCH 6/6] Update documentation/API_documentation/CFS-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- documentation/API_documentation/CFS-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/CFS-API-Readiness-Checklist.md b/documentation/API_documentation/CFS-API-Readiness-Checklist.md index 972565b..f448372 100644 --- a/documentation/API_documentation/CFS-API-Readiness-Checklist.md +++ b/documentation/API_documentation/CFS-API-Readiness-Checklist.md @@ -12,7 +12,7 @@ Checklist for API call-forwarding-signal v0.2.0-rc.1 in r1.1 | 4 | API versioning convention applied | M | M | M | M | Y | v0.2.0-rc.1 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | /documentation/API_documentation/CFS_UserStory_UseCase-1.md | -| 7 | Basic API test cases & documentation | O | M | M | M | N | code/Test_definitions/call-forwarding-signal-every-forwarding.feature, code/Test_definitions/call-forwarding-signal-unconditional.feature | +| 7 | Basic API test cases & documentation | O | M | M | M | N | /code/Test_definitions/call-forwarding-signal-every-forwarding.feature, /code/Test_definitions/call-forwarding-signal-unconditional.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.1 |