From 3c17992c850e56722c6869840569f7dee44d49c7 Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Mon, 15 Jul 2024 20:38:30 +0200 Subject: [PATCH 1/7] Carrier Billing APIs Readiness Checklist MetaRelase Fall24 --- ... Billing Refund-API-Readiness-Checkkist.md | 27 +++++++++++++ ...Carrier Billing-API-Readiness-Checklist.md | 40 +++++++++++++------ 2 files changed, 54 insertions(+), 13 deletions(-) create mode 100644 documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md diff --git a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md new file mode 100644 index 0000000..d97f38b --- /dev/null +++ b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md @@ -0,0 +1,27 @@ +# API Readiness Checklist + +Checklist for Carrier Billing Refund v0.1.0 in r0.3. + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +| 1 | API definition | M | M | M | M | Y | link | +| 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 | link | +| 6 | User stories | O | O | O | M | Y | link | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | link | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | +| 9 | Test result statement | O | O | O | M | N | link | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | link | +| 12 | Previous public release was certified | O | O | O | M | N | | + +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) diff --git a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md index b6a5745..6a92496 100644 --- a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md @@ -1,13 +1,27 @@ -# Carrier Billing API Readiness minimum criteria checklist - -
- -| No | Deliverables/Criteria | Mandatory | Status (Contributed/Approved/Pending/Validated/Partly-Validated)| -|----|-----------------------------------|-----------|------------------------| -| 1 |API Spec | Y | Contributed | -| 2 |API Implementation | Y | Contributed | -| 3 |API Documentation | Y | Contributed | -| 4 |User Stories | Y | Contributed | -| 5 |API test cases | Y | Not Contributed | -| 6 |Validated by at least 2 operators | Y | N/A | -| 7 |Security review | N | Contributed | +# API Readiness Checklist + +Checklist for Carrier Billing v0.3.0 in r0.3. + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +| 1 | API definition | M | M | M | M | Y | link | +| 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 | link | +| 6 | User stories | O | O | O | M | Y | link | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | link | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | +| 9 | Test result statement | O | O | O | M | N | link | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | link | +| 12 | Previous public release was certified | O | O | O | M | N | | + +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) From 9a89e07e95c3c81817d91500cbf6241b2c0f302c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Thu, 1 Aug 2024 11:40:03 +0200 Subject: [PATCH 2/7] Update documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md Co-authored-by: Herbert Damker --- .../Carrier Billing Refund-API-Readiness-Checkkist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md index d97f38b..2c9bfef 100644 --- a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md +++ b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for Carrier Billing Refund v0.1.0 in r0.3. +Checklist for Carrier Billing Refund v0.1.0 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 738deac18132a15a3ecb209151e1e46523844472 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Thu, 1 Aug 2024 11:40:48 +0200 Subject: [PATCH 3/7] Update documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md Co-authored-by: Herbert Damker --- .../Carrier Billing Refund-API-Readiness-Checkkist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md index 2c9bfef..e5d47be 100644 --- a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md +++ b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md @@ -4,7 +4,7 @@ Checklist for Carrier Billing Refund v0.1.0 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | Y | link | +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/carrier_billing_refund.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 | | From 4722a0911e3149b673bd039d219eefe412c69c16 Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Thu, 1 Aug 2024 18:31:28 +0200 Subject: [PATCH 4/7] fix_release_number --- .../Carrier Billing Refund-API-Readiness-Checkkist.md | 4 ++-- .../Carrier Billing-API-Readiness-Checklist.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md index e5d47be..1550f42 100644 --- a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md +++ b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md @@ -9,8 +9,8 @@ Checklist for Carrier Billing Refund v0.1.0 in r1.1 | 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 | link | -| 6 | User stories | O | O | O | M | Y | link | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | link | +| 6 | User stories | O | O | O | M | N | link | +| 7 | Basic API test cases & documentation | O | M | M | M | N | link | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | | 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | diff --git a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md index 6a92496..1da2be2 100644 --- a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md @@ -1,16 +1,16 @@ # API Readiness Checklist -Checklist for Carrier Billing v0.3.0 in r0.3. +Checklist for Carrier Billing v0.3.0 in r1.1. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | Y | link | +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/carrier_billing.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 | link | | 6 | User stories | O | O | O | M | Y | link | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | link | +| 7 | Basic API test cases & documentation | O | M | M | M | N | link | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | | 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | From 3bbce9de37d74b4a5790bf930994a78edb2f0d82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Thu, 1 Aug 2024 19:39:38 +0200 Subject: [PATCH 5/7] Update documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md Co-authored-by: Herbert Damker --- .../Carrier Billing Refund-API-Readiness-Checkkist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md index 1550f42..3df4782 100644 --- a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md +++ b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for Carrier Billing Refund v0.1.0 in r1.1 +Checklist for Carrier Billing Refund v0.1.0-rc.1 in r1.1 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 73a297db0dc8e769719756a3894eefb5aaec17f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20D=C3=ADez=20Garc=C3=ADa?= Date: Thu, 1 Aug 2024 19:39:50 +0200 Subject: [PATCH 6/7] Update documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../Carrier Billing-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md index 1da2be2..f836424 100644 --- a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for Carrier Billing v0.3.0 in r1.1. +Checklist for Carrier Billing v0.3.0-rc.1 in r1.1. | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 8516ac0664946da4e2f78cac631379eb75e793e4 Mon Sep 17 00:00:00 2001 From: PEDRO DIEZ GARCIA Date: Thu, 1 Aug 2024 19:44:19 +0200 Subject: [PATCH 7/7] add_changelog_link --- .../Carrier Billing Refund-API-Readiness-Checkkist.md | 2 +- .../Carrier Billing-API-Readiness-Checklist.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md index 3df4782..850d94e 100644 --- a/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md +++ b/documentation/API_documentation/Carrier Billing Refund-API-Readiness-Checkkist.md @@ -14,7 +14,7 @@ Checklist for Carrier Billing Refund v0.1.0-rc.1 in r1.1 | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | | 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | -| 11 | Change log updated | M | M | M | M | Y | link | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | N | | To fill the checklist: diff --git a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md index f836424..fb7a26c 100644 --- a/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md +++ b/documentation/API_documentation/Carrier Billing-API-Readiness-Checklist.md @@ -14,7 +14,7 @@ Checklist for Carrier Billing v0.3.0-rc.1 in r1.1. | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | | 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | -| 11 | Change log updated | M | M | M | M | Y | link | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | N | | To fill the checklist: