Release r2.2 (Fall'25 M4)

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## Table of Contents
 
-- **[r2.1](#r21)**
+- **[r2.2](#r22)**
+- [r2.1](#r21)
 - [r1.2](#r12)
 - [r1.1](#r11)
 
@@ -14,12 +15,45 @@ 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
+# r2.2
+
+## Release Notes
+
+This public release contains the definition and documentation of
+* kyc-tenure v0.2.0
+
+The API definition(s) are based on
+* Commonalities [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3)
+* Identity and Consent Management [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3)
+
+## kyc-tenure v0.2.0
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r2.2/code/API_definitions/kyc-tenure.yaml&nocors)
+  - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r2.2/code/API_definitions/kyc-tenure.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/Tenure/blob/r2.2/code/API_definitions/kyc-tenure.yaml)
+
+There are no breaking changes compared to v0.1.0
+
+### Added
+* Add text on undocumented errors to OAS definition by @eric-murray in https://github.com/camaraproject/Tenure/pull/42
+
+### Changed
+* Update x-correlator pattern by @eric-murray in https://github.com/camaraproject/Tenure/pull/40
+
+### Fixed
+* Fix/contract-type-line-break by @fernandopradocabrillo in https://github.com/camaraproject/Tenure/pull/37
+
+### Removed
+* Remove AUTHENTICATION_REQUIRED error code by @eric-murray in https://github.com/camaraproject/Tenure/pull/33
+
+**Full Changelog**: https://github.com/camaraproject/Tenure/compare/r1.2...r2.2
 
 # r2.1
 
 ## Release Notes
 
-This release contains the definition and documentation of
+This pre-release contains the definition and documentation of
 * kyc-tenure v0.2.0-rc.1
 
 The API definition(s) are based on

README.md

@@ -22,15 +22,15 @@ Sandbox API Repository to describe, develop, document, and test the Tenure Servi
 
 ## Release Information
 
-* 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
-* **The latest public release of CAMARA Tenure is [r1.2](https://github.com/camaraproject/Tenure/tree/r1.2)**. The Release Tag is [r1.2](https://github.com/camaraproject/Tenure/releases/tag/r1.2).
+**The latest public release of CAMARA Tenure is release [r2.2](https://github.com/camaraproject/Tenure/releases/tag/r2.2)**.
   * API definition **with inline documentation**:
-    * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r1.2/code/API_definitions/kyc-tenure.yaml&nocors)
-    * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r1.2/code/API_definitions/kyc-tenure.yaml)
-    * OpenAPI [YAML spec file](https://github.com/camaraproject/Tenure/blob/r1.2/code/API_definitions/kyc-tenure.yaml)
-* Other releases of this sub project are available in https://github.com/camaraproject/Tenure/releases
-* For changes see [CHANGELOG.md](https://github.com/camaraproject/Tenure/blob/main/CHANGELOG.md)
+    * [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r2.2/code/API_definitions/kyc-tenure.yaml&nocors)
+    * [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r2.2/code/API_definitions/kyc-tenure.yaml)
+    * OpenAPI [YAML spec file](https://github.com/camaraproject/Tenure/blob/r2.2/code/API_definitions/kyc-tenure.yaml)
+* Other releases of this sandbox repository are available [here](https://github.com/camaraproject/Tenure/releases)
+* For changes see the [CHANGELOG.md](https://github.com/camaraproject/Tenure/blob/main/CHANGELOG.md)
 
+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
 ## Contributing
 * Meetings and minutes see [KnowYourCustomer Meetings](https://github.com/camaraproject/KnowYourCustomer?tab=readme-ov-file#meetings)
 * Mailing List

code/API_definitions/kyc-tenure.yaml

@@ -6,14 +6,6 @@ info:
 
     The CAMARA Know Your Customer (KYC) Tenure API allows for verification that a network subscriber has been a customer of the Communications Service Provider (CSP) for a specified minimum length of time so as to establish a level of trust for the associated network subscription identifier.
 
-    # 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.
-
     # API functionality
 
     The API defines one service endpoint:
@@ -88,7 +80,7 @@ info:
 
     (FAQs will be added in a later version of the documentation)
 
-  version: wip
+  version: 0.2.0
   x-camara-commonalities: 0.6
   license:
     name: Apache 2.0
@@ -99,7 +91,7 @@ externalDocs:
   url: https://github.com/camaraproject/Tenure
 
 servers:
-  - url: "{apiRoot}/kyc-tenure/vwip"
+  - url: "{apiRoot}/kyc-tenure/v0.2"
     variables:
       apiRoot:
         default: https://localhost:9091

code/Test_definitions/kyc-tenure.feature

@@ -1,4 +1,4 @@
-Feature: CAMARA Tenure API, vwip - Operation checkTenure
+Feature: CAMARA Tenure API, v0.2.0 - Operation checkTenure
   # Input to be provided by the implementation to the tester
   #
   # Implementation indications:
@@ -10,7 +10,7 @@ Feature: CAMARA Tenure API, vwip - Operation checkTenure
 
   Background: Common checkTenure setup
     Given an environment at "apiRoot"
-    And the resource "/kyc-tenure/vwip/check-tenure"
+    And the resource "/kyc-tenure/v0.2/check-tenure"
     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"

documentation/API_documentation/kyc-tenure-API-Readiness-Checklist.md

@@ -1,19 +1,19 @@
 # API Readiness Checklist
 
-Checklist for kyc-tenure v0.2.0-rc.1 in r2.1
+Checklist for kyc-tenure v0.2.0 in r2.2
 
 | Nr | API release assets  | alpha | release-candidate |  initial<br>public | stable<br> public | Status | Reference information |
 |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
 |  1 | API definition                               |   M   |         M         |    M    |    M   |  Y   | [relative link](/code/API_definitions/kyc-tenure.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) |
+|  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   |   |
-|  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | Embedded documentation into API spec [relative link](/code/API_definitions/kyc-tenure.yaml) |
+|  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | Documentation embedded within [API definition](/code/API_definitions/kyc-tenure.yaml) |
 |  6 | User stories                                 |   O   |         O         |    O    |    M   |  N   |   |
 |  7 | Basic API test cases & documentation         |   O   |         M         |    M    |    M   |  Y   | [relative link](/code/Test_definitions/kyc-tenure.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   |  r2.1 |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |  r2.2 |
 | 11 | Change log updated                           |   M   |         M         |    M    |    M   |  Y   | [relative 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/wAPWB) |