Public Release for Fall24 meta-release

CHANGELOG.md

@@ -3,6 +3,7 @@
 
 ## Table of Contents
 
+- **[r1.3](#r13)**
 - **[r1.2-rc](#r12-rc)**
 - **[r1.1-rc](#r11-rc)**
 
@@ -14,6 +15,36 @@ The below sections record the changes for each API version in each release as fo
 * for subsequent alpha or release-candidate API versions, the delta with respect to the previous pre-release
 * for a public API version, the consolidated changes since the release of the previous public API version
 
+# r1.3
+
+## Release Notes
+
+This release contains the definition and documentation of
+* call-forwarding-signal v0.2.0
+
+The API definition(s) are based on
+* Commonalities v0.4.0
+* Identity and Consent Management v0.2.0
+
+## call-forwarding-signal v0.2.0
+
+This is the first official release of the Call Forwarding Signal API, version 0.2.0. It contains mainly alignments with the Commonalities 0.4.0 and the Release Management Guidelines. 
+
+- API definition **with inline documentation**:
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.3/code/API_definitions/call-forwarding-signal.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.3/code/API_definitions/call-forwarding-signal.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.3/code/API_definitions/call-forwarding-signal.yaml)
+
+Because this is the first official release, in the following there is a full list of the features supported by the API, including the features listed in the previous release candidates.
+
+## What's New
+
+* Support for the following use cases: [Use Cases · camaraproject/CallForwardingSignal · Discussion #3 (github.com)](https://github.com/camaraproject/CallForwardingSignal/discussions/3)
+* Phone  number retrieved from 3-legs access token: [CAMARA Guidelines: Phone number identification with 3Legs · Issue #51 · camaraproject/CallForwardingSignal (github.com)](https://github.com/camaraproject/CallForwardingSignal/issues/51)
+* Optional operation (/call-forwardings):  [Optional operations · Issue #37 · camaraproject/CallForwardingSignal (github.com)](https://github.com/camaraproject/CallForwardingSignal/issues/37)
+
+**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/commits/r1.3
+
 # r1.2-rc
 
 ## Release Notes
@@ -88,4 +119,3 @@ The version number for the YAML file is v0.2.0-rc.1
 **Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/commits/r1.1
 
 
-

README.md

@@ -15,23 +15,22 @@ Repository to describe, develop, document and test the Call Forwarding Signal AP
   * The Application Server invokes the Call Forwarding Signal API to determine if a specific phone number has an active "call forwarding" setup. "Call forwarding" is a network service that redirects incoming calls to another phone number (configured in the service). The Call Forwarding Signal API can be used by a bank to verify if a “call forwarding” option is active on the customer’s phone number to avoid frauds. A call from the bank to the customers can indeed be forwarded to a different number because of a fraud attempt.
   * The API is useful to avoid frauds. Banks offer the option for users to receive telephone calls to solve problems, e.g. in case of issues with the bank App, issues with Smartphones, the bank website or any tool providing access to the online bank account management system.<br>How does the fraudster operate?<br>• Through social engineering, the fraudster gathers information about bank customers who are engaged in such a situation, needing the bank to contact them.<br>• Once they identify the service provider and phone number of a customer, they manage to successfully activate, on the customer profile, the 'call forwarding' to a phone number they control.<br>• After successfully setting up 'call forwarding,' the fraudster then contacts the bank, claiming an inability to access online banking services and requesting a call from a bank representative. <br>• When the bank calls the registered contact number of the user, the active 'call forwarding' diverts the call directly to the fraudster, thus completing their scheme.<br> The Call Forwarding Signal API can be used by the bank to verify if a "call forwarding" option is active on the customer's phone, avoiding such a fraud.
 * Describe, develop, document and test the APIs (with 1-2 Telcos)  
-* Started: February 2024
-* Location: virtually  
+* Started: February 2024 
 
 ## Meetings
 * Meetings are held virtually
-* Schedule: Tuesday 15h-16 CET, usually every two weeks. For the next meeting date, have a look on the API Wiki Page: https://wiki.camaraproject.org/display/CAM/CallForwardingSignal 
-* Meeting link: https://teams.microsoft.com/l/meetup-join/19%3ameeting_ZTc1YzI4YjEtMmNlZC00NGJmLWE3MmMtNjJhYzdhZTU3YmFj%40thread.v2/0?context=%7b%22Tid%22%3a%226815f468-021c-48f2-a6b2-d65c8e979dfb%22%2c%22Oid%22%3a%22bfbe4cda-8a8b-4cda-89e2-7326520e45b3%22%7d 
+* Schedule: Tuesday 15h-16 CET, usually every two weeks. For the next meetings information, have a look on the API Wiki Page: https://wiki.camaraproject.org/display/CAM/CallForwardingSignal
+* Location: virtually
 
 ## Status and released versions
 
 * 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 available version of CAMARA CallForwardingSignal API is v0.2.0-rc.2. This is a release-candidate API version.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments.
-* The Release Tag is [r1.2](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r1.2).
+* **The latest available version of CAMARA CallForwardingSignal API is v0.2.0.**
+* The Release Tag is [r1.3](https://github.com/camaraproject/CallForwardingSignal/releases/tag/r1.3).
 - API definition **with inline documentation**:
-  - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml)
-  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml&nocors)
-  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.2/code/API_definitions/Call_Forwarding_Signal.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/CallForwardingSignal/blob/r1.3/code/API_definitions/call-forwarding-signal.yaml)
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.3/code/API_definitions/call-forwarding-signal.yaml&nocors)
+  - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/CallForwardingSignal/r1.3/code/API_definitions/call-forwarding-signal.yaml)
 ## Contributorship and mailing list
 * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit <https://lists.camaraproject.org/g/sp-cfs>.
 * A message to all Contributors of this Sub Project can be sent using <sp-cfs@lists.camaraproject.org>.

code/API_definitions/Call_Forwarding_Signal.yaml → code/API_definitions/call-forwarding-signal.yaml

@@ -132,19 +132,19 @@ info:
     # FAQ's
     (FAQs will be added in a later version of the documentation)
 
-  version: 0.2.0-rc.2
+  version: 0.2.0
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  x-camara-commonalities: 0.4.0-rc.2
+  x-camara-commonalities: 0.4.0
 externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/CallForwardingSignal
 ############################################################################
 #                                     Servers                              #
 ############################################################################
 servers:
-  - url: "{apiRoot}/call-forwarding-signal/v0.2rc2"
+  - url: "{apiRoot}/call-forwarding-signal/v0.2"
     variables:
       apiRoot:
         default: http://localhost:9091
@@ -226,7 +226,7 @@ paths:
        service active on a phone number (PhoneNumber)
       description: This endpoint provides information about wich type of
        call forwarding service is active. More than one service can be
-       active, e.g. conditional and unconditional. This endpoit exceeds
+       active, e.g. conditional and unconditional. This endpoint exceeds
        the main scope of the CFS API, for this reason an error code 501
        can be returned.
       operationId: retrieveCallForwarding

code/Test_definitions/call-forwarding-signal-every-forwarding.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Call Fowarwing Signal  API, v0.2.0-rc.2 - Operation call-forwardings
+Feature: CAMARA Call Fowarwing Signal  API, v0.2.0 - Operation call-forwardings
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:

code/Test_definitions/call-forwarding-signal-unconditional.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Call Fowarwing Signal  API, v0.2.0-rc.2 - Operation unconditional-call-forwarding
+Feature: CAMARA Call Fowarwing Signal  API, v0.2.0 - Operation unconditional-call-forwarding
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:
@@ -129,7 +129,7 @@ Feature: CAMARA Call Fowarwing Signal  API, v0.2.0-rc.2 - Operation unconditiona
 
   # Generic 409 error - conflict
   @call_forwarding_signal_409.1_already_exists
-  Scenario: Endpoint involked, by the same API Consumer, for a phone number whose status is already under verification
+  Scenario: Endpoint invoked, by the same API Consumer, for a phone number whose status is already under verification
       Given a pending request for a given phone number
       And a the same phone number for a new request
       When the HTTP "POST" for the second request is sent before the first request gets an answer
@@ -170,7 +170,7 @@ Feature: CAMARA Call Fowarwing Signal  API, v0.2.0-rc.2 - Operation unconditiona
       And the response property "$.message" contains a user friendly text
 
   @call_forwarding_signal_429.2_too_many_requests
-    Scenario: The server is not able to handle a requst because of a lack of resources
+    Scenario: The server is not able to handle a request because of a lack of resources
       Given the number of endpoints calls from any APi Consumer is equal to the server limit
       And the endpoint is invoked
       When the HTTP "POST" request is sent

documentation/API_documentation/call-forwarding-signal-API-Readiness-Checklistst.md

@@ -1,21 +1,20 @@
 
 # API Readiness Checklist
 
-Checklist for API call-forwarding-signal v0.2.0-rc.2 in r1.2
+Checklist for API call-forwarding-signal v0.2.0 in r1.3
 
 
 | Nr | API release assets  | alpha | release-candidate |  public-release<br>initial | public-release<br> stable | Status | Comments |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----|
-|  1 | API definition                               |   M   |         M         |    M    |    M   |   Y  | /code/API_definitions/Call_Forwarding_Signal.yaml |
+|  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  |      |
 |  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y  |      |
-|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y  | v0.2.0-rc.2 |
+|  4 | API versioning convention applied            |   M   |         M         |    M    |    M   |   Y  | v0.2.0 |
 |  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   |   Y  | /code/Test_definitions/call-forwarding-signal-every-forwarding.feature, /code/Test_definitions/call-forwarding-signal-unconditional.feature |
+|  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   |   N  |      |
 |  9 | Test result statement                        |   O   |         O         |    O    |    M   |   N  |      |
-| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y  | r1.2 |
-| 11 | Change log updated                           |   M   |         M         |    M    |    M   |   Y  | /CHANGELOG.md |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |   Y  | r1.3 |
+| 11 | Change log updated                           |   M   |         M         |    M    |    M   |   Y  | [link](/CHANGELOG.md) |
 | 12 | Previous public-release was certified        |   O   |         O         |    O    |    M   |   N  |      |
-