Release r2.1 (Fall'25 M3)

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## Table of Contents
 
-- **[r1.2](#r12)**
+- **[r2.1](#r21)**
+- [r1.2](#r12)
 - [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.**
@@ -14,6 +15,40 @@ 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
 
+# r2.1
+
+## Release Notes
+
+This release contains the definition and documentation of
+* kyc-tenure v0.2.0-rc.1
+
+The API definition(s) are based on
+* Commonalities v0.6.0-rc.1
+* Identity and Consent Management v0.4.0-rc.1
+
+## kyc-tenure v0.2.0-rc.1
+
+- API definition **with inline documentation**:
+  - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/Tenure/r2.1/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.1/code/API_definitions/kyc-tenure.yaml)
+  - OpenAPI [YAML spec file](https://github.com/camaraproject/Tenure/blob/r2.1/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...2.1
+
 # r1.2
 
 ## Release Notes

code/API_definitions/kyc-tenure.yaml

@@ -88,8 +88,8 @@ info:
 
     (FAQs will be added in a later version of the documentation)
 
-  version: wip
-  x-camara-commonalities: 0.5
+  version: 0.2.0-rc.1
+  x-camara-commonalities: 0.6
   license:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0.html
@@ -99,7 +99,7 @@ externalDocs:
   url: https://github.com/camaraproject/Tenure
 
 servers:
-  - url: "{apiRoot}/kyc-tenure/vwip"
+  - url: "{apiRoot}/kyc-tenure/v0.2rc1"
     variables:
       apiRoot:
         default: https://localhost:9091

code/Test_definitions/kyc-tenure.feature

@@ -1,21 +1,20 @@
-Feature: CAMARA Tenure API, vwip - Operation checkTenure
+Feature: CAMARA Tenure API, v0.2.0-rc.1 - Operation checkTenure
     # Input to be provided by the implementation to the tester
     #
     # Implementation indications:
     #
     # Testing assets:
     # * A mobile line identified by its phone number "phoneNumber"
     #
-    # References to OAS spec schemas refer to schemas specifies in kyc-tenure.yaml
+    # References to OAS spec schemas refer to schemas specified in kyc-tenure.yaml
 
     Background: Common checkTenure setup
         Given an environment at "apiRoot"
-        And the resource "/kyc-tenure/vwip/check-tenure"
+        And the resource "/kyc-tenure/v0.2rc1/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" is set to a UUID value
+        And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator"
         And the request body is set by default to a request body compliant with the schema
-
 
     # Happy path scenarios
 

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

@@ -1,19 +1,19 @@
 # API Readiness Checklist
 
-Checklist for kyc-tenure v0.1.0 in r1.2.
+Checklist for kyc-tenure v0.2.0-rc.1 in r2.1
 
 | 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   | [r2.3](https://github.com/camaraproject/Commonalities/releases/tag/r2.3) |
-|  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   | [r2.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r2.3) |
+|  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   |   |
 |  5 | API documentation                            |   M   |         M         |    M    |    M   |  Y   | Embedded documentation into API spec [relative link](/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   |   |
+| 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |  r2.1 |
 | 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   |      | [wiki link](https://lf-camaraproject.atlassian.net/wiki/xxx) |
+| 13 | API description (for marketing)              |   O   |         O         |    M    |    M   |  Y   | [wiki link](https://lf-camaraproject.atlassian.net/wiki/x/wAPWB) |