From bbad7a060c10a10fd5ccd6da5d6cfebfdcc50c65 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 20 Aug 2025 16:53:35 +0200 Subject: [PATCH 1/8] M4 OAS from wip to 0.4.0 --- code/API_definitions/call-forwarding-signal.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/call-forwarding-signal.yaml b/code/API_definitions/call-forwarding-signal.yaml index 0fee782..747302d 100644 --- a/code/API_definitions/call-forwarding-signal.yaml +++ b/code/API_definitions/call-forwarding-signal.yaml @@ -151,7 +151,7 @@ info: # FAQ's (FAQs will be added in a later version of the documentation) - version: wip + version: 0.4.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html @@ -163,7 +163,7 @@ externalDocs: # Servers # ############################################################################ servers: - - url: "{apiRoot}/call-forwarding-signal/vwip" + - url: "{apiRoot}/call-forwarding-signal/v0.4" variables: apiRoot: default: http://localhost:9091 From c735e3edc6070b3fe3c88e15b57cdd2733fc209f Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 20 Aug 2025 16:54:03 +0200 Subject: [PATCH 2/8] M4 test files from wip to 0.4.0 --- .../call-forwarding-signal-retrieveCallForwarding.feature | 6 +++--- ...rding-signal-retrieveUnconditionalCallForwarding.feature | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/code/Test_definitions/call-forwarding-signal-retrieveCallForwarding.feature b/code/Test_definitions/call-forwarding-signal-retrieveCallForwarding.feature index 29549ef..a48ccda 100644 --- a/code/Test_definitions/call-forwarding-signal-retrieveCallForwarding.feature +++ b/code/Test_definitions/call-forwarding-signal-retrieveCallForwarding.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveCallForwarding +Feature: CAMARA Call Forwarding Signal API, v0.4.0 - Operation retrieveCallForwarding # Input to be provided by the implementation to the tester # # Implementation indications: @@ -7,10 +7,10 @@ Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveCallForwar # * A device object identified by a phone number for which the call forwarding service status could be retrieved # * A device object identified by a phone number for which the call forwarding service status could not be retrieved # - # References to OAS spec schemas refer to schemas specified in call-forwarding-signal.yaml, version wip + # References to OAS spec schemas refer to schemas specified in call-forwarding-signal.yaml, version 0.4.0 Background: Common call-forwarding-signal setup - Given the path "/call-forwarding-signal/vwip/call-forwardings" + Given the path "/call-forwarding-signal/v0.4/call-forwardings" 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" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/code/Test_definitions/call-forwarding-signal-retrieveUnconditionalCallForwarding.feature b/code/Test_definitions/call-forwarding-signal-retrieveUnconditionalCallForwarding.feature index 972e236..ba65f49 100644 --- a/code/Test_definitions/call-forwarding-signal-retrieveUnconditionalCallForwarding.feature +++ b/code/Test_definitions/call-forwarding-signal-retrieveUnconditionalCallForwarding.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveUnconditionalCallForwarding +Feature: CAMARA Call Forwarding Signal API, v0.4.0 - Operation retrieveUnconditionalCallForwarding # Input to be provided by the implementation to the tester # # Implementation indications: @@ -7,10 +7,10 @@ Feature: CAMARA Call Forwarding Signal API, vwip - Operation retrieveUnconditio # * A device object identified by a phone number for which unconditional call forwarding service (CFS) status could be retrieved # * A device object identified by a phone number for which unconditional call forwarding service (CFS) status could not be retrieved # - # References to OAS spec schemas refer to schemas specified in call-forwarding-signal.yaml, version wip + # References to OAS spec schemas refer to schemas specified in call-forwarding-signal.yaml, version 0.4.0 Background: Common call-forwarding-signal setup - Given the path "/call-forwarding-signal/vwip/unconditional-call-forwardings" + Given the path "/call-forwarding-signal/v0.4/unconditional-call-forwardings" 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" complies with the schema at "#/components/schemas/XCorrelator" From c49565a99cda8a7b99d1d48b4785b59ad773df4c Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 20 Aug 2025 16:54:47 +0200 Subject: [PATCH 3/8] M4 RCL --- ...call-forwarding-signal-API-Readiness-Checklist.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md b/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md index 59880b0..63bc55a 100644 --- a/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md +++ b/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md @@ -1,22 +1,24 @@ # API Readiness Checklist -Checklist for API call-forwarding-signal v0.4.0-rc.1 in r3.2 +Checklist for API call-forwarding-signal v0.4.0 in r3.3 | 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/call-forwarding-signal.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.4.0-rc.1 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | +| 4 | API versioning convention applied | M | M | M | M | Y | v0.4.0 | | 5 | API documentation | M | M | M | M | Y | inline in YAML | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/CFS_UserStory_UseCase-1.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [call-forwarding-signal-every-forwarding](/code/Test_definitions/call-forwarding-signal-every-forwarding.feature), [call-forwarding-signal-unconditional](/code/Test_definitions/call-forwarding-signal-unconditional.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [call-forwarding-signal-every-forwarding](/code/Test_definitions/call-forwarding-signal-every-forwarding.feature), [call-forwarding-signal-unconditional](/code/Test_definitions/call-forwarding-signal-unconditional.feature) | | 9 | Test result statement | O | O | O | M | N | | -| 10 | API release numbering convention applied | M | M | M | M | Y | r3.2 | +| 10 | API release numbering convention applied | M | M | M | M | Y | r3.3 | | 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 | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/uoDVB) | + + From 2281d8f445ca083287dbd695d14b709c4e1058d5 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 20 Aug 2025 16:55:18 +0200 Subject: [PATCH 4/8] M4 readme and changelog --- CHANGELOG.md | 57 ++++++++++++++++++++++++++++++++++++++++++++-------- README.md | 10 ++++----- 2 files changed, 53 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c38caf..681e793 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## Table of Contents +- **[r3.3](#r33)** - **[r3.2](#r32)** - **[r3.1](#r31)** - **[r2.2](#r22)** @@ -20,6 +21,44 @@ 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 +# r3.3 + +## Release Notes + +This release contains the definition and documentation of call-forwarding-signal v0.4.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## call-forwarding-signal v0.4.0 + +This is a release candidate for the CAMARA Meta Release Fall25 release of the Call Forwarding Signal API, version v0.4.0. It is mainly an alignment with Commonalities v0.6.0. + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r3.3/code/API_definitions/call-forwarding-signal.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml) + +In the following there is the list of the modifications with respect to the previous release. + +### Added + +### Changed + * x-correlator new format: https://github.com/camaraproject/CallForwardingSignal/pull/180, https://github.com/camaraproject/CallForwardingSignal/pull/186 + * Undocumented Errors note in info.description: https://github.com/camaraproject/CallForwardingSignal/pull/180 + +### Fixed + * fixed some typo: https://github.com/camaraproject/CallForwardingSignal/pull/190 + * Enum Value Mismatch Between API and Tests: https://github.com/camaraproject/CallForwardingSignal/pull/190 + * ErrorInfo scheme updated: https://github.com/camaraproject/CallForwardingSignal/pull/201 + * Updated schema context in test definition: https://github.com/camaraproject/CallForwardingSignal/pull/201 + +### Removed + * Removed error 401: https://github.com/camaraproject/CallForwardingSignal/pull/180 + +**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r2.2...r3.3 + # r3.2 ## Release Notes @@ -45,15 +84,14 @@ In the following there is the list of the modifications with respect to the prev ### Added ### Changed - * x-correlator new format: https://github.com/camaraproject/CallForwardingSignal/pull/180, https://github.com/camaraproject/CallForwardingSignal/pull/186 - * Undocumented Errors note in info.description: https://github.com/camaraproject/CallForwardingSignal/pull/180 ### Fixed - +* fixed some typo: https://github.com/camaraproject/CallForwardingSignal/pull/190 +* Enum Value Mismatch Between API and Tests: https://github.com/camaraproject/CallForwardingSignal/pull/190 + ### Removed - * Removed error 401: https://github.com/camaraproject/CallForwardingSignal/pull/180 -**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r2.2...r3.2 +**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r3.1...r3.2 # r3.1 @@ -116,11 +154,12 @@ In the following there is the list of the modifications with respect to the prev ### Changed * Call Forwarding Service "state" terminology updated: https://github.com/camaraproject/CallForwardingSignal/pull/117 - * Alignment with CAMARA Guidelines in info.description: https://github.com/camaraproject/CallForwardingSignal/pull/121, https://github.com/camaraproject/CallForwardingSignal/issues/158 + * Alignment with CAMARA Guidelines in info.description: https://github.com/camaraproject/CallForwardingSignal/pull/121 * Enhancements and Alignments in Errors: https://github.com/camaraproject/CallForwardingSignal/pull/121 * Align API-Testing with CAMARA Guidelines: https://github.com/camaraproject/CallForwardingSignal/pull/121 - * Changed error code 404: https://github.com/camaraproject/CallForwardingSignal/issues/160 - * Alignement with Commonalities for x-correlator and Error 429: https://github.com/camaraproject/CallForwardingSignal/issues/159 + * Authorization and authentication documentatiopn update: https://github.com/camaraproject/CallForwardingSignal/pull/154 + * Changed error code 404: https://github.com/camaraproject/CallForwardingSignal/pull/154 + * Alignement with Commonalities for x-correlator and Error 429: https://github.com/camaraproject/CallForwardingSignal/pull/154 ### Fixed @@ -273,3 +312,5 @@ The version number for the YAML file is v0.2.0-rc.1 **Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/commits/r1.1 + + diff --git a/README.md b/README.md index c36288c..9b86a50 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,11 @@ Incubating API Repository to evolve and maintain the definitions and documentati * Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* **NEW**: Pre-release [r3.2](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.2) with call-forwarding-signal v0.4.0-rc.1 is available. - -* The latest public release is [r2.2](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r2.2) with call-forwarding-signal v0.3.0. +* The latest public release is [r3.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.3) with call-forwarding-signal v0.4.0. - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r2.2/code/API_definitions/call-forwarding-signal.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r2.2/code/API_definitions/call-forwarding-signal.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r2.2/code/API_definitions/call-forwarding-signal.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r3.3/code/API_definitions/call-forwarding-signal.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml) ## Contributing * Meetings are held virtually * Schedule: Monday 15h-16 CET, usually every two weeks. For the next meetings information, have a look on the [API Wiki Page](https://lf-camaraproject.atlassian.net/wiki/spaces/CAM/pages/14549020/CallForwardingSignal). From 4879c8717f0b1ee1d7043fb42ca2636e7b1b862f Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Wed, 20 Aug 2025 17:00:12 +0200 Subject: [PATCH 5/8] added link to RCL documentation --- .../call-forwarding-signal-API-Readiness-Checklist.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md b/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md index 63bc55a..8eecf49 100644 --- a/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md +++ b/documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklist.md @@ -20,5 +20,4 @@ Checklist for API call-forwarding-signal v0.4.0 in r3.3 | 12 | Previous public-release was certified | O | O | O | M | N | | | 13 | API description (for marketing) | O | O | M | M | Y | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/uoDVB) | - - +The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). \ No newline at end of file From 6631e32235551ad56994bdf6f9ec837dbac4921a Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 14:16:16 +0200 Subject: [PATCH 6/8] Update CHANGELOG.md --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 681e793..5f7ddac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -33,7 +33,7 @@ The API definition(s) are based on ## call-forwarding-signal v0.4.0 -This is a release candidate for the CAMARA Meta Release Fall25 release of the Call Forwarding Signal API, version v0.4.0. It is mainly an alignment with Commonalities v0.6.0. +This is the third public release of the Call Forwarding Signal API, version v0.4.0. It is mainly an alignment with Commonalities v0.6.0. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r3.3/code/API_definitions/call-forwarding-signal.yaml) @@ -314,3 +314,4 @@ The version number for the YAML file is v0.2.0-rc.1 + From 2d72e9e56addc4311976237d9da08def0faa6a51 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 25 Aug 2025 14:29:53 +0200 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9b86a50..1e2a9ec 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Incubating API Repository to evolve and maintain the definitions and documentati * Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* The latest public release is [r3.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.3) with call-forwarding-signal v0.4.0. +* `NEW`: The latest public release is [r3.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r3.3) with call-forwarding-signal v0.4.0. - API definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r3.3/code/API_definitions/call-forwarding-signal.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r3.3/code/API_definitions/call-forwarding-signal.yaml&nocors) From 726d3707da320ea7dcab2c03a3bd400e0c7826c9 Mon Sep 17 00:00:00 2001 From: FabrizioMoggio <87469955+FabrizioMoggio@users.noreply.github.com> Date: Mon, 8 Sep 2025 08:49:47 +0200 Subject: [PATCH 8/8] Update README.md https://github.com/camaraproject/CallForwardingSignal/pull/204#discussion_r2328361641 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1e2a9ec..1427cd5 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ Incubating API Repository to evolve and maintain the definitions and documentati ## Scope * Service APIs for “CallForwardingSignal” (see APIBacklog.md) * It provides the API consumer with the ability to: - * retrive information about the status of the Call Forwarding Service on a specific phone number. - * avoid frauds leveraging on the Call Forwarding Service. - * The main scope of the CFS API is "anti Fraud" to avoid fraudsters to use the Call Forwarding Service to carry on a scam. Other use cases are anyway supported by the CFS API that also provides additional endpoints to detect the general Call Forwarding Service settings. + * retrieve information about the status of the Call Forwarding Service on a specific phone number. + * avoid fraud leveraging the Call Forwarding Service. + * The main scope of the Call Forwarding Signal API is anti fraud to avoid fraudsters to use the Call Forwarding Service to carry on a scam. Other use cases are anyway supported by the Call Forwarding Signal API that also provides additional endpoints to detect the general Call Forwarding Service settings. * Describe, develop, document and test the API * Started: February 2024 * Incubating stage since: February 2025