From 352ef81543747f1255abfc70415a669367d7caad Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:34:39 +0800 Subject: [PATCH 01/34] Create CHANGELOG.MD --- CHANGELOG.MD | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CHANGELOG.MD diff --git a/CHANGELOG.MD b/CHANGELOG.MD new file mode 100644 index 0000000..1e95421 --- /dev/null +++ b/CHANGELOG.MD @@ -0,0 +1,41 @@ +# Changelog Subscription Status + +## Table of Contents +- **[r1.1](#r11)** + +**Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.** + +# r1.1 + +## Release Notes + + +This release contains the definition and documentation of +* subscription-status v0.1.0-rc.1 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + + + +## subscription-status v0.1.0-rc.1 + +**subscription-status v0.1.0-rc.1 is the first release-candidate version for v0.1.0 of the Subscription Status API. + + + API definition **with inline documentation**: +[[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.1/code/API_definitions/subscription-status.yaml) +[[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml&nocors) +[[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml) + +**Initial contribution of API definitions for Subscription Status**, including initial documentation and implementation code. + +## What's Changed +* Initial yaml file including Subscription Status API in https://github.com/camaraproject/SubscriptionStatus/pull/6 +* Add test file in https://github.com/camaraproject/SubscriptionStatus/pull/9 +* change yaml file to align commonalities v0.6.0 +Remove AUTHENTICATION_REQUIRED error code +Update x-correlator format +Add text on undocumented errors to OAS definition +in https://github.com/camaraproject/SubscriptionStatus/pull/13 From 12e246b730e843bd8a9836851d28d366420848bd Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:35:56 +0800 Subject: [PATCH 02/34] Update CHANGELOG.MD --- CHANGELOG.MD | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 1e95421..6c6c024 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -34,8 +34,7 @@ The API definition(s) are based on ## What's Changed * Initial yaml file including Subscription Status API in https://github.com/camaraproject/SubscriptionStatus/pull/6 * Add test file in https://github.com/camaraproject/SubscriptionStatus/pull/9 -* change yaml file to align commonalities v0.6.0 -Remove AUTHENTICATION_REQUIRED error code -Update x-correlator format -Add text on undocumented errors to OAS definition -in https://github.com/camaraproject/SubscriptionStatus/pull/13 +* Remove AUTHENTICATION_REQUIRED error code in https://github.com/camaraproject/SubscriptionStatus/pull/13 +* Update x-correlator format in https://github.com/camaraproject/SubscriptionStatus/pull/13 +* Add text on undocumented errors to OAS definition in https://github.com/camaraproject/SubscriptionStatus/pull/13 + From 5934d90e1d5d591c45f500aa63ea58216b06ada0 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:39:00 +0800 Subject: [PATCH 03/34] Update CHANGELOG.MD --- CHANGELOG.MD | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 6c6c024..6e60203 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -32,9 +32,9 @@ The API definition(s) are based on **Initial contribution of API definitions for Subscription Status**, including initial documentation and implementation code. ## What's Changed -* Initial yaml file including Subscription Status API in https://github.com/camaraproject/SubscriptionStatus/pull/6 -* Add test file in https://github.com/camaraproject/SubscriptionStatus/pull/9 -* Remove AUTHENTICATION_REQUIRED error code in https://github.com/camaraproject/SubscriptionStatus/pull/13 -* Update x-correlator format in https://github.com/camaraproject/SubscriptionStatus/pull/13 -* Add text on undocumented errors to OAS definition in https://github.com/camaraproject/SubscriptionStatus/pull/13 +* Initial yaml file including Subscription Status API by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/6 +* Add test file by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/9 +* Remove AUTHENTICATION_REQUIRED error code by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 +* Update x-correlator format by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 +* Add text on undocumented errors to OAS definition by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 From b193decb0e026dec00d67a467cd71aee7660511c Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:47:31 +0800 Subject: [PATCH 04/34] Create subscription-status-API-Readiness-Checklist.md --- ...cription-status-API-Readiness-Checklist.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 documentation/API_documentation/subscription-status-API-Readiness-Checklist.md diff --git a/documentation/API_documentation/subscription-status-API-Readiness-Checklist.md b/documentation/API_documentation/subscription-status-API-Readiness-Checklist.md new file mode 100644 index 0000000..70a4404 --- /dev/null +++ b/documentation/API_documentation/subscription-status-API-Readiness-Checklist.md @@ -0,0 +1,19 @@ +# API Readiness Checklist + +Checklist for subscription-status v0.1.0-rc.1 in r1.1 + +| Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/subscription-status.yaml) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | +| 4 | API versioning convention applied | M | M | M | M | Y | v0.1.0-rc.1 | +| 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/subscription-status.yaml) | +| 6 | User stories | O | O | O | M | N | | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/subscription-status.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_definitions/subscription-status.feature) | +| 9 | Test result statement | O | O | O | M | N | To be provided | +| 10 | API release numbering convention applied | M | M | M | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | +| 12 | Previous public release was certified | O | O | O | M | N | | +| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/94044292/SubscriptionStatus) | From 68ddbf03fbcd11b1cb545bff37509cd88ebc4ab8 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:49:50 +0800 Subject: [PATCH 05/34] Update release candidate version number --- code/API_definitions/subscription-status.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index 694401a..c4b9161 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -63,14 +63,14 @@ info: Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - version: wip + version: v0.1.0-rc.1 x-camara-commonalities: 0.6 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - - url: "{apiRoot}/subscription-status/wip" + - url: "{apiRoot}/subscription-status/v0.1rc1" variables: apiRoot: default: http://localhost:9091 From 1fb5c32b171f029d50dbb3f1471668922fcedcda Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:51:16 +0800 Subject: [PATCH 06/34] Update subscription-status.feature rc version number --- code/Test_definitions/subscription-status.feature | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/code/Test_definitions/subscription-status.feature b/code/Test_definitions/subscription-status.feature index ec4530a..ee0d9db 100644 --- a/code/Test_definitions/subscription-status.feature +++ b/code/Test_definitions/subscription-status.feature @@ -1,7 +1,7 @@ -Feature: CAMARA SubscriptionStatus API, vwip - Retrieve subscription status of a phone number +Feature: CAMARA SubscriptionStatus API, v0.1rc1 - Retrieve subscription status of a phone number Background: Common setup - Given the endpoint "{apiRoot}/subscription-status/wip/retrive-subscription-status" + Given the endpoint "{apiRoot}/subscription-status/v0.1rc1/retrive-subscription-status" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" is set to a UUID value @@ -67,4 +67,4 @@ Scenario: Error when service not available And the request body contains this phone number When the HTTP "POST" request is sent Then the response status code is 422 - And the response contains error code "SERVICE_NOT_APPLICABLE" \ No newline at end of file + And the response contains error code "SERVICE_NOT_APPLICABLE" From 99fab3a0479d669690f38bae85e1aa4d92a38964 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:52:04 +0800 Subject: [PATCH 07/34] Delete code/Test_definitions/README.md --- code/Test_definitions/README.md | 1 - 1 file changed, 1 deletion(-) delete mode 100644 code/Test_definitions/README.md diff --git a/code/Test_definitions/README.md b/code/Test_definitions/README.md deleted file mode 100644 index 27a1f06..0000000 --- a/code/Test_definitions/README.md +++ /dev/null @@ -1 +0,0 @@ -This directory contains at least one `.feature` file containing test definitions for the repository API(s). From 2452381e0100a40baab4d02cade00314913d28ec Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:52:16 +0800 Subject: [PATCH 08/34] Delete code/API_definitions/README.MD --- code/API_definitions/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 code/API_definitions/README.MD diff --git a/code/API_definitions/README.MD b/code/API_definitions/README.MD deleted file mode 100644 index 04313f1..0000000 --- a/code/API_definitions/README.MD +++ /dev/null @@ -1 +0,0 @@ -Here you can add your definitions and delete this README.MD file From 9ae0de06a3d69d6c4fd3789a77294dadec0ab037 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:52:32 +0800 Subject: [PATCH 09/34] Delete documentation/API_documentation/README.MD --- documentation/API_documentation/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 documentation/API_documentation/README.MD diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD deleted file mode 100644 index 37aa0ff..0000000 --- a/documentation/API_documentation/README.MD +++ /dev/null @@ -1 +0,0 @@ -This README.MD can be deleted when the first file is added to this directory. From 76adb2651dee678d313e930e22c8059c93c80d90 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 01:59:37 +0800 Subject: [PATCH 10/34] Update README.md --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0754760..5e41f04 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Sandbox API Repository to describe, develop, document, and test the Subscription * Service API “SubscriptionStatus” (see [APIBacklog.md](https://github.com/camaraproject/APIBacklog/blob/main/documentation/APIbacklog.md)) * The API provides the customer with the ability to: - * obtain the current subscription status of a certain phone number, including the subscription of Voice/SMS in, Voice/SMS out, and data service + * obtain the current subscription status of a certain phone number, including the subscription of Voice/SMS Inbound, Voice/SMS Outbound, and Data Service Status * Describe, develop, document, and test the APIs * Started: August 2024 @@ -30,6 +30,13 @@ The repository has no (pre)releases yet, work in progress is within the main bra + * `NEW`: Pre-release r1.1 with version 0.1.0-rc.1 of the API subscription-status is available [here](https://github.com/camaraproject/SubscriptionStatus/tree/r1.1). + [[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.1/code/API_definitions/subscription-status.yaml) + [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml&nocors) + [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml) + +* For changes see [CHANGELOG.md](https://github.com/camaraproject/RegionDeviceCount/blob/main/CHANGELOG.md) + ## Contributing * Meetings of Sub Project KnowYourCustomer are held virtually * Schedule: Bi-weekly, Tuesday, 09:00 CEST (07:00 UTC) From 9032ffa0c700af1b381d1af55f7854d15a468255 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Sat, 28 Jun 2025 02:00:25 +0800 Subject: [PATCH 11/34] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e41f04..fa4b005 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ The repository has no (pre)releases yet, work in progress is within the main bra [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml&nocors) [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml) -* For changes see [CHANGELOG.md](https://github.com/camaraproject/RegionDeviceCount/blob/main/CHANGELOG.md) +* For changes see [CHANGELOG.md](https://github.com/camaraproject/SubscriptionStatus/blob/main/CHANGELOG.md) ## Contributing * Meetings of Sub Project KnowYourCustomer are held virtually From b0d3df02b16afcf6e0a14d7e95ff7214eb4fb7ea Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 3 Jul 2025 12:56:15 +0100 Subject: [PATCH 12/34] fix: added text from the release management template CHANGELOG.md Added --- CHANGELOG.MD | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 6e60203..568c3b8 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -5,6 +5,12 @@ **Please be aware that the project will have frequent updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until it has been released. For example, changes may be reverted before a release is published. For the best results, use the latest published release.** +The below sections record the changes for each API version in each release as follows: + +* for an alpha release, the delta with respect to the previous release +* for the first release-candidate, all changes since the last public release +* for subsequent release-candidate(s), only the delta to the previous release-candidate +* for a public release, the consolidated changes since the previous public release # r1.1 ## Release Notes From 9e33bc68dca631d4bcbf76c46834784de87706a5 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 3 Jul 2025 13:12:44 +0100 Subject: [PATCH 13/34] fix: added `-rc.1` to Commonalities version --- CHANGELOG.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 568c3b8..6726aec 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -20,7 +20,7 @@ This release contains the definition and documentation of * subscription-status v0.1.0-rc.1 The API definition(s) are based on -* Commonalities v0.6.0 +* Commonalities v0.6.0-rc.1 * Identity and Consent Management v0.4.0 From abf0e00e534dfb4c1e1000d8d7f6d1a706e7b625 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 3 Jul 2025 13:13:21 +0100 Subject: [PATCH 14/34] fix: added -rc.1 to ICM version --- CHANGELOG.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 6726aec..30e518d 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -21,7 +21,7 @@ This release contains the definition and documentation of The API definition(s) are based on * Commonalities v0.6.0-rc.1 -* Identity and Consent Management v0.4.0 +* Identity and Consent Management v0.4.0-rc.1 From 399fb336f707d137f8f44252d968ff41fd73b50d Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 3 Jul 2025 14:44:22 +0100 Subject: [PATCH 15/34] fix: corrected version syntax --- code/Test_definitions/subscription-status.feature | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/Test_definitions/subscription-status.feature b/code/Test_definitions/subscription-status.feature index ee0d9db..440e3d4 100644 --- a/code/Test_definitions/subscription-status.feature +++ b/code/Test_definitions/subscription-status.feature @@ -1,4 +1,5 @@ -Feature: CAMARA SubscriptionStatus API, v0.1rc1 - Retrieve subscription status of a phone number +Feature: CAMARA SubscriptionStatus API, v0.1-rc.1 - Retrieve subscription status of a phone number + Background: Common setup Given the endpoint "{apiRoot}/subscription-status/v0.1rc1/retrive-subscription-status" From bda42f4dd9a0e29b5e3822dfb93cd4637364146d Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Fri, 4 Jul 2025 11:14:57 +0100 Subject: [PATCH 16/34] Removed mention of 'implementation code' --- CHANGELOG.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 30e518d..32f8aec 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -35,7 +35,7 @@ The API definition(s) are based on [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml&nocors) [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml) -**Initial contribution of API definitions for Subscription Status**, including initial documentation and implementation code. +**Initial contribution of API definitions for Subscription Status**, including initial documentation. ## What's Changed * Initial yaml file including Subscription Status API by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/6 From bb96d12c7c2a2334a0e6f38f6f4422467c878b49 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Fri, 4 Jul 2025 11:21:26 +0100 Subject: [PATCH 17/34] Reformatted 'what's changed' into preferred headings --- CHANGELOG.MD | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 32f8aec..c526939 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -37,10 +37,13 @@ The API definition(s) are based on **Initial contribution of API definitions for Subscription Status**, including initial documentation. -## What's Changed +## Added * Initial yaml file including Subscription Status API by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/6 * Add test file by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/9 -* Remove AUTHENTICATION_REQUIRED error code by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 -* Update x-correlator format by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 * Add text on undocumented errors to OAS definition by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 +## Removed +* Remove AUTHENTICATION_REQUIRED error code by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 + +## Changed +* Update x-correlator format by @chinaunicomyangfan in https://github.com/camaraproject/SubscriptionStatus/pull/13 From 0df8579f0606a490b3e1a99a7fec22fab5962e60 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 4 Jul 2025 18:24:43 +0800 Subject: [PATCH 18/34] Remove 403 KnowYourCustomer ErrorCode --- code/API_definitions/subscription-status.yaml | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index c4b9161..89457f3 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -261,8 +261,6 @@ components: enum: - PERMISSION_DENIED - INVALID_TOKEN_CONTEXT - - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED - - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH examples: GENERIC_403_PERMISSION_DENIED: description: Permission denied. OAuth2 token access does not have the required scope or when the user fails operational security @@ -276,18 +274,6 @@ components: status: 403 code: INVALID_TOKEN_CONTEXT message: "phoneNumber is not consistent with access token." - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED: - description: The idDocument is required by the implementation - value: - status: 403 - code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_REQUIRED - message: The idDocument is required to perform the properties validation - KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH: - description: idDocument mismatch - value: - status: 403 - code: KNOW_YOUR_CUSTOMER.ID_DOCUMENT_MISMATCH - message: The idDocument needs to match the one associated with the provided phoneNumber Generic404: description: Not found From 9ae0efbca9d0d2c5ebbc4e3e1663ebac7ce206d6 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Fri, 4 Jul 2025 11:31:02 +0100 Subject: [PATCH 19/34] fix: Moved externalDocs to expected place, changed to template text --- code/API_definitions/subscription-status.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index 89457f3..a60b575 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -68,7 +68,9 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - +externalDocs: + description: Product documentation at CAMARA + url: https://github.com/camaraproject/SubscriptionStatus servers: - url: "{apiRoot}/subscription-status/v0.1rc1" variables: From 33e87ded9e783e712506733a0cc7129d15bdf28d Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Fri, 4 Jul 2025 11:32:30 +0100 Subject: [PATCH 20/34] fix: moved to expected location at start of document --- code/API_definitions/subscription-status.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index a60b575..baa9b1c 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -342,6 +342,3 @@ components: status: 422 code: UNNECESSARY_IDENTIFIER message: An explicit phone number has been provided when one is already associated with the access token -externalDocs: - description: Camara Project Documentation - url: https://github.com/camaraproject/SubscriptionStatus From 8dfca9f55ab87e36e9ec770bf2e607e71702048f Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Fri, 4 Jul 2025 11:41:58 +0100 Subject: [PATCH 21/34] format: added carriage return --- CHANGELOG.MD | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index c526939..8dc30ee 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -11,6 +11,7 @@ The below sections record the changes for each API version in each release as fo * for the first release-candidate, all changes since the last public release * for subsequent release-candidate(s), only the delta to the previous release-candidate * for a public release, the consolidated changes since the previous public release + # r1.1 ## Release Notes From c637c91876e164a8409b6b6479522f2a59a14299 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Wed, 9 Jul 2025 10:02:12 +0800 Subject: [PATCH 22/34] Update XCorrelator schema in yaml file --- code/API_definitions/subscription-status.yaml | 27 +++++++++---------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index baa9b1c..cbc7252 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -107,7 +107,7 @@ paths: description: Subscription status retrieved successfully headers: x-correlator: - $ref: "#/components/headers/X-Correlator" + $ref: "#/components/headers/x-correlator" content: application/json: schema: @@ -134,18 +134,17 @@ components: in: header description: Correlation ID for cross-service tracking schema: - type: string - pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ - example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" + $ref: "#/components/schemas/XCorrelator" headers: - X-Correlator: + x-correlator: description: Correlation id for the different services - required: false schema: - type: string - pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ - example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" + $ref: "#/components/schemas/XCorrelator" schemas: + XCorrelator: + type: string + pattern: ^[a-zA-Z0-9-_:;.\/<>{}]{0,256}$ + example: "b4333c46-49c0-4f62-80d7-f0ef930f1c46" SubscriptionStatusRequest: type: object properties: @@ -196,7 +195,7 @@ components: description: Bad Request headers: x-correlator: - $ref: "#/components/headers/X-Correlator" + $ref: "#/components/headers/x-correlator" content: application/json: schema: @@ -222,7 +221,7 @@ components: description: Unauthorized headers: x-correlator: - $ref: "#/components/headers/X-Correlator" + $ref: "#/components/headers/x-correlator" content: application/json: schema: @@ -248,7 +247,7 @@ components: description: Forbidden headers: x-correlator: - $ref: "#/components/headers/X-Correlator" + $ref: "#/components/headers/x-correlator" content: application/json: schema: @@ -281,7 +280,7 @@ components: description: Not found headers: x-correlator: - $ref: "#/components/headers/X-Correlator" + $ref: "#/components/headers/x-correlator" content: application/json: schema: @@ -307,7 +306,7 @@ components: description: Unprocessable Content headers: x-correlator: - $ref: "#/components/headers/X-Correlator" + $ref: "#/components/headers/x-correlator" content: application/json: schema: From 3078238e84e5f41bd916a77bb196fdb2a3a6ed2f Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 11 Jul 2025 09:42:45 +0800 Subject: [PATCH 23/34] Apply suggestions from code review Co-authored-by: Kevin Smith --- code/API_definitions/subscription-status.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index cbc7252..2f3a97e 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -63,7 +63,8 @@ info: Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - version: v0.1.0-rc.1 + version: 0.1.0-rc.1 + x-camara-commonalities: 0.6 license: name: Apache 2.0 From 148f327d8e056d0bb50c2a46c9d3dd9ed964e81b Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 11 Jul 2025 09:42:58 +0800 Subject: [PATCH 24/34] Apply suggestions from code review Co-authored-by: Kevin Smith --- code/Test_definitions/subscription-status.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/subscription-status.feature b/code/Test_definitions/subscription-status.feature index 440e3d4..6614659 100644 --- a/code/Test_definitions/subscription-status.feature +++ b/code/Test_definitions/subscription-status.feature @@ -2,7 +2,7 @@ Feature: CAMARA SubscriptionStatus API, v0.1-rc.1 - Retrieve subscription status Background: Common setup - Given the endpoint "{apiRoot}/subscription-status/v0.1rc1/retrive-subscription-status" + Given the resource "/subscription-status/v0.1rc1/retrieve-subscription-status" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" is set to a UUID value From 5aab16ae1aa2fe0885194b26857e3cdbad3fe484 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 11 Jul 2025 09:43:25 +0800 Subject: [PATCH 25/34] Apply suggestions from code review Co-authored-by: Kevin Smith --- code/Test_definitions/subscription-status.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/subscription-status.feature b/code/Test_definitions/subscription-status.feature index 6614659..2c43670 100644 --- a/code/Test_definitions/subscription-status.feature +++ b/code/Test_definitions/subscription-status.feature @@ -5,7 +5,7 @@ Background: Common setup Given the resource "/subscription-status/v0.1rc1/retrieve-subscription-status" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token - And the header "x-correlator" is set to a UUID value + And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" # Happy path scenarios From b2567678e6d7af8fa89968bf0f2c8ed677874363 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 11 Jul 2025 09:43:50 +0800 Subject: [PATCH 26/34] Apply suggestions from code review Co-authored-by: Kevin Smith --- .../subscription-status-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/subscription-status-API-Readiness-Checklist.md b/documentation/API_documentation/subscription-status-API-Readiness-Checklist.md index 70a4404..bc92243 100644 --- a/documentation/API_documentation/subscription-status-API-Readiness-Checklist.md +++ b/documentation/API_documentation/subscription-status-API-Readiness-Checklist.md @@ -16,4 +16,4 @@ Checklist for subscription-status v0.1.0-rc.1 in r1.1 | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public release was certified | O | O | O | M | N | | -| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/94044292/SubscriptionStatus) | +| 13 | API description (for marketing) | O | O | M | M | | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/hACbBQ) | From dc41b4f2245940f22092799a8c4cf4394a0bdc82 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 11 Jul 2025 09:44:03 +0800 Subject: [PATCH 27/34] Apply suggestions from code review Co-authored-by: Kevin Smith --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa4b005..fa8ffa8 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,12 @@ The repository has no (pre)releases yet, work in progress is within the main bra - * `NEW`: Pre-release r1.1 with version 0.1.0-rc.1 of the API subscription-status is available [here](https://github.com/camaraproject/SubscriptionStatus/tree/r1.1). + +* Note: Please be aware that the project will have updates to the main branch. There are no compatibility guarantees associated with code in any branch, including main, until a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. + + * Pre-release r1.1 with version 0.1.0-rc.1 of the API subscription-status is available [here](https://github.com/camaraproject/SubscriptionStatus/tree/r1.1). + +
This is a release candidate version of the API. Until the public release there are bug fixes to be expected. The release candidate is suitable for implementors, but it is not recommended to use the API with customers in productive environments. [[YAML]](https://github.com/camaraproject/SubscriptionStatus/blob/r1.1/code/API_definitions/subscription-status.yaml) [[View it on ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml&nocors) [[View it on Swagger Editor]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/SubscriptionStatus/r1.1/code/API_definitions/subscription-status.yaml) From b543f39c3ad736e4a5b6813df0460264345f2a20 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 11 Jul 2025 09:44:17 +0800 Subject: [PATCH 28/34] Apply suggestions from code review Co-authored-by: Kevin Smith --- CHANGELOG.MD | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 8dc30ee..b577aca 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -12,6 +12,7 @@ The below sections record the changes for each API version in each release as fo * for subsequent release-candidate(s), only the delta to the previous release-candidate * for a public release, the consolidated changes since the previous public release + # r1.1 ## Release Notes From 5bca4c28bfb6c25bdf0279f139967de4501cae22 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Fri, 11 Jul 2025 09:44:25 +0800 Subject: [PATCH 29/34] Apply suggestions from code review Co-authored-by: Kevin Smith --- CHANGELOG.MD | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index b577aca..367f72e 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -7,6 +7,12 @@ The below sections record the changes for each API version in each release as follows: +* for an alpha release, the delta with respect to the previous release +* for the first release-candidate, all changes since the last public release +* for subsequent release-candidate(s), only the delta to the previous release-candidate +* for a public release, the consolidated changes since the previous public release +The below sections record the changes for each API version in each release as follows: + * for an alpha release, the delta with respect to the previous release * for the first release-candidate, all changes since the last public release * for subsequent release-candidate(s), only the delta to the previous release-candidate From 9ed579ec5f17062033b191b97da1c5c34cba3070 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Mon, 14 Jul 2025 17:17:42 +0800 Subject: [PATCH 30/34] Add the mandatory Authorization and authentication text Add the mandatory Authorization and authentication text --- code/API_definitions/subscription-status.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index 2f3a97e..05ecef7 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -63,6 +63,11 @@ info: Please refer to the `CAMARA_common.yaml` of the Commonalities Release associated to this API version for a complete list of error responses. The applicable Commonalities Release can be identified in the `API Readiness Checklist` document associated to this API version. As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. + # Authorization and authentication + The "Camara Security and Interoperability Profile" provides details of how an API consumer requests an access token. Please refer to Identity and Consent Management (https://github.com/camaraproject/IdentityAndConsentManagement/) for the released version of the profile. + The specific authorization flows to be used will be agreed upon during the onboarding process, happening between the API consumer and the API provider, taking into account the declared purpose for accessing the API, whilst also being subject to the prevailing legal framework dictated by local legislation. + In cases where personal data is processed by the API and users can exercise their rights through mechanisms such as opt-in and/or opt-out, the use of three-legged access tokens is mandatory. This ensures that the API remains in compliance with privacy regulations, upholding the principles of transparency and user-centric privacy-by-design. + version: 0.1.0-rc.1 x-camara-commonalities: 0.6 From de57394db17a18c9815128439de672e6ae41cadf Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Tue, 15 Jul 2025 09:12:25 +0800 Subject: [PATCH 31/34] Update CHANGELOG.MD Delete duplication --- CHANGELOG.MD | 6 ------ 1 file changed, 6 deletions(-) diff --git a/CHANGELOG.MD b/CHANGELOG.MD index 367f72e..b577aca 100644 --- a/CHANGELOG.MD +++ b/CHANGELOG.MD @@ -7,12 +7,6 @@ The below sections record the changes for each API version in each release as follows: -* for an alpha release, the delta with respect to the previous release -* for the first release-candidate, all changes since the last public release -* for subsequent release-candidate(s), only the delta to the previous release-candidate -* for a public release, the consolidated changes since the previous public release -The below sections record the changes for each API version in each release as follows: - * for an alpha release, the delta with respect to the previous release * for the first release-candidate, all changes since the last public release * for subsequent release-candidate(s), only the delta to the previous release-candidate From f1a1df0b445f66f309997e64282e11082a0e746e Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Tue, 15 Jul 2025 09:12:57 +0800 Subject: [PATCH 32/34] Update code/Test_definitions/subscription-status.feature Co-authored-by: Herbert Damker --- code/Test_definitions/subscription-status.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_definitions/subscription-status.feature b/code/Test_definitions/subscription-status.feature index 2c43670..52195f9 100644 --- a/code/Test_definitions/subscription-status.feature +++ b/code/Test_definitions/subscription-status.feature @@ -1,4 +1,4 @@ -Feature: CAMARA SubscriptionStatus API, v0.1-rc.1 - Retrieve subscription status of a phone number +Feature: CAMARA SubscriptionStatus API, v0.1.0-rc.1 - Retrieve subscription status of a phone number Background: Common setup From 459c115e70b17d2239b3793af755527e0dd03f27 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Mon, 21 Jul 2025 11:01:38 +0800 Subject: [PATCH 33/34] Add description to the /retrive-subscription-status path Add description to the /retrive-subscription-status path --- code/API_definitions/subscription-status.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index 05ecef7..a646dcb 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -92,6 +92,8 @@ paths: - subscription-status:retrive-subscription-status tags: - Retrive Subscription Status + description: | + Oobtain the business subscription status of the provided phone number, including Voice/SMS inbound, Voice/SMS outbound, and data service status. operationId: retriveSubscriptionStatus summary: Retrieve subscription status of a phone number parameters: From 89d55cea467beafc016b4e4a2e9ccfa901049fc1 Mon Sep 17 00:00:00 2001 From: Fan Yang-ChinaUnicom <130550398+chinaunicomyangfan@users.noreply.github.com> Date: Mon, 21 Jul 2025 16:44:31 +0800 Subject: [PATCH 34/34] Update subscription-status.yaml --- code/API_definitions/subscription-status.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/subscription-status.yaml b/code/API_definitions/subscription-status.yaml index a646dcb..038cfab 100644 --- a/code/API_definitions/subscription-status.yaml +++ b/code/API_definitions/subscription-status.yaml @@ -93,7 +93,7 @@ paths: tags: - Retrive Subscription Status description: | - Oobtain the business subscription status of the provided phone number, including Voice/SMS inbound, Voice/SMS outbound, and data service status. + Obtain the business subscription status of the provided phone number, including Voice/SMS inbound, Voice/SMS outbound, and data service status. operationId: retriveSubscriptionStatus summary: Retrieve subscription status of a phone number parameters: