Merge pull request #91 from camaraproject/72-create-release-r12

Prepare release r1.2
camaraproject · Aug 7, 2024 · 7fe0355 · 7fe0355
2 parents c85ffa2 + 73180a0
commit 7fe0355
Show file tree

Hide file tree

Showing 4 changed files with 67 additions and 65 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,8 +3,55 @@
 
 ## Table of Contents
 
-- **[r1.1-rc](#r11-rc)**
 - **[r1.2-rc](#r12-rc)**
+- **[r1.1-rc](#r11-rc)**
+
+**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 each first alpha or release-candidate API version, all changes since the release of the previous public API version
+* 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.2-rc
+
+## Release Notes
+
+This release contains the definition and documentation of
+* call-forwarding-signal v0.2.0-rc.2
+
+The API definition(s) are based on
+* Commonalities v0.4.0-rc.1
+* Identity and Consent Management v0.2.0-rc.2
+
+## call-forwarding-signal v0.2.0-rc.2
+
+This is the second release candidate of the version 0.2.0. It contains mainly alignments with the Commonalities 0.4.0 and the Release Management Guidelines. 
+
+The pre-release is suitable for implementers, but it is not recommended to use the API with customers in productive environments.
+
+- 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)
+
+### Added
+
+### Changed
+
+* Improvement of user stories by @FabrizioMoggio in https://github.com/camaraproject/CallForwardingSignal/pull/86
+* Aligned info.description Authorization and Authentication section with ICM 0.2.0 by @FabrizioMoggio in https://github.com/camaraproject/CallForwardingSignal/pull/91
+
+### Fixed
+
+* Removed the version number in the ".feature" files in the "Background" section by @FabrizioMoggiom in https://github.com/camaraproject/CallForwardingSignal/pull/83
+* Alignments within object description and fields by @FabrizioMoggio in https://github.com/camaraproject/CallForwardingSignal/pull/68
+
+### Removed
+
+
+**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/compare/r1.1...r1.2
 
 # r1.1-rc
 
@@ -19,7 +66,7 @@ The version number for the YAML file is v0.2.0-rc.1
 
 ## Please note:
 
-- This pre-release concernes a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions 
+- This pre-release contains a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions 
 - The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments
 - Version numbers before v0.2.0-rc.1 were used during the development of this version but not released
 - The release scope is defined here: https://github.com/camaraproject/CallForwardingSignal/issues/49
@@ -40,39 +87,5 @@ The version number for the YAML file is v0.2.0-rc.1
 
 **Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/commits/r1.1
 
-# r1.2-rc
-
-**This is the second pre-release of the CAMARA CallForwardingSignal API**
-
-The version number for the YAML file is v0.2.0-rc.2
-
-- 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)
-
-## Please note:
-
-- This pre-release concernes a release-candidate API version, there are bug fixes to be expected and incompatible changes in upcoming versions 
-- The release is suitable for implementers, but it is not recommended to use the API with customers in productive environments
-- The release scope is defined here: https://github.com/camaraproject/CallForwardingSignal/issues/72
-
-## Changes compared with [r1.1-rc](#r11-rc)
-
-* The contact field (and value) have been be removed from the OAS file: https://github.com/camaraproject/CallForwardingSignal/issues/76
-* Update of the API Readiness Checklist: https://github.com/camaraproject/CallForwardingSignal/issues/80
-* Rename of the API Readiness Checklist: https://github.com/camaraproject/CallForwardingSignal/issues/79
-* Improvement of the user stories: https://github.com/camaraproject/CallForwardingSignal/issues/81
-* Removal of the version number in the ".feature" files in the "Background" section: https://github.com/camaraproject/CallForwardingSignal/issues/77
-* Commonalities version reported in the OAS file: https://github.com/camaraproject/CallForwardingSignal/issues/66
-
-## New Contributors
-* @FabrizioMoggio
-* @bigludo7
-* @rartych
-* @StefanoFalsetto-CKHIOD
-* @enlaichu
-* @chinaunicomyangfan
 
-**Full Changelog**: https://github.com/camaraproject/CallForwardingSignal/commits/r1.2
 
diff --git a/code/API_definitions/Call_Forwarding_Signal.yaml b/code/API_definitions/Call_Forwarding_Signal.yaml
@@ -72,31 +72,23 @@ info:
     - **call-forwardings**: Which is the status of the call forwarding for a
     specific phone number?
     # Authorization and authentication
-    CAMARA guidelines defines a set of authorization flows which can grant API
-    clients access to the API functionality, as outlined in the document
-    [CAMARA-API-access-and-user-consent.md](https:\
-    //github.com/camaraproject/IdentityAndConsentManagement/blob/main/\
-    documentation/CAMARA-API-access-and-user-consent.md).
+    The "Camara Security and Interoperability Profile" provides details on how
+    a client requests an access token. Please refer to Identify and Consent
+    Management (https://github.com/camaraproject/IdentityAndConsentManagement/)
+    for the released version of the Profile.\
+    \
     Which specific authorization flows are to be used will be determined during
-    onboarding process, happening between the API Client and the
-    Telco Operator exposing the API, taking into account the declared purpose
-    for accessing the API, while also being subject to the prevailing legal
-    framework dictated by local legislation.\
-    Specifically, for the CFS API, the CIBA flow should be adopted. The CIBA
-    flow is described here:[CIBA Flow](https://github.com/camaraproject/\
-    IdentityAndConsentManagement/blob/main/documentation/\
-    CAMARA-Security-Interoperability.md\
-    #client-initiated-backchannel-authentication-flow). The "login_hint" must be
-    the user's phone number valorised as the parameter PhoneNumber, if used. If
-    a mismatch is detected, a 403 error is returned (`INVALID_TOKEN_CONTEXT`).
+    onboarding process, happening between the API Client and the Telco Operator
+    exposing the API, taking into account the declared purpose for accessing the
+    API, while also being subject to the prevailing legal framework dictated by
+    local legislation.\
     \
     It is important to remark that in cases where personal user 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 3-legged access tokens becomes
-    mandatory.
-    This measure ensures that the API remains in strict compliance with user
-    privacy preferences and regulatory obligations,
-    upholding the principles of transparency and user-centric data control.
+    mandatory. This measure ensures that the API remains in strict compliance
+    with user privacy preferences and regulatory obligations, upholding the
+    principles of transparency and user-centric data control.
     # Identifying the phone number from the access token
     This specification defines the "phoneNumber" field as optional in API
     requests because using a 3-legged access token the phone number can be
@@ -139,26 +131,24 @@ info:
     to be checked.
     # FAQ's
     (FAQs will be added in a later version of the documentation)
-  # API version - Aligned to SemVer 2.0 according to CAMARA versioning guidelines
-  version: wip
-  # Name of the license and a URL to the license description
+
+  version: 0.2.0-rc.2
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
-  # CAMARA Commonalities version - x.y.z
-  x-camara-commonalities: 0.4.0
+  x-camara-commonalities: 0.4.0-rc.2
 externalDocs:
   description: Product documentation at CAMARA
   url: https://github.com/camaraproject/CallForwardingSignal
 ############################################################################
 #                                     Servers                              #
 ############################################################################
 servers:
-  - url: "{apiRoot}/call-forwarding-signal/vwip"
+  - url: "{apiRoot}/call-forwarding-signal/v0.2rc2"
     variables:
       apiRoot:
         default: http://localhost:9091
-        description: API root for the Call Forwarding Signal API
+        description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath`
 ############################################################################
 #                                     Tags                                #
 ############################################################################

diff --git a/code/API_definitions/README.MD b/code/API_definitions/README.MD
diff --git a/...mentation/API_documentation/call-forwarding-signal-API-Readiness-Checklistst.md b/...mentation/API_documentation/call-forwarding-signal-API-Readiness-Checklistst.md
@@ -5,7 +5,7 @@ Checklist for API call-forwarding-signal v0.2.0-rc.2 in r1.2
 
 
 | 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 |
 |  2 | Design guidelines from Commonalities applied |   O   |         M         |    M    |    M   |   Y  |      |
 |  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |   Y  |      |