From ca2f7760571c8c68157a0d85392142612a6d3576 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Fri, 15 Aug 2025 11:09:49 +0100 Subject: [PATCH 1/8] Update kyc-tenure-API-Readiness-Checklist.md --- .../kyc-tenure-API-Readiness-Checklist.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/kyc-tenure-API-Readiness-Checklist.md b/documentation/API_documentation/kyc-tenure-API-Readiness-Checklist.md index a2f1845..588ed8f 100644 --- a/documentation/API_documentation/kyc-tenure-API-Readiness-Checklist.md +++ b/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
public | stable
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) | From cbaee9f4e73cf36cc3492b092aacf33dd3e739cf Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Fri, 15 Aug 2025 11:15:53 +0100 Subject: [PATCH 2/8] Update CHANGELOG.md --- CHANGELOG.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9b2a5dd..ec73c9b 100644 --- a/CHANGELOG.md +++ b/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 From 3ada46c2c9bf67402845258652a0924c4a4c99f6 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Fri, 15 Aug 2025 11:17:30 +0100 Subject: [PATCH 3/8] Update kyc-tenure.yaml --- code/API_definitions/kyc-tenure.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/kyc-tenure.yaml b/code/API_definitions/kyc-tenure.yaml index 5d306ff..862efec 100644 --- a/code/API_definitions/kyc-tenure.yaml +++ b/code/API_definitions/kyc-tenure.yaml @@ -88,7 +88,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 +99,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 From c6a226f754b4fe12e15c93b70b88ee8b630888a6 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Fri, 15 Aug 2025 11:18:07 +0100 Subject: [PATCH 4/8] Update kyc-tenure.feature --- code/Test_definitions/kyc-tenure.feature | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/kyc-tenure.feature b/code/Test_definitions/kyc-tenure.feature index 91c7834..abc7b7f 100644 --- a/code/Test_definitions/kyc-tenure.feature +++ b/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" From 2d793b89ede8ef3fdf5d40de370e1513b1052f3a Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Fri, 15 Aug 2025 11:24:52 +0100 Subject: [PATCH 5/8] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1de08c1..52c1bb7 100644 --- a/README.md +++ b/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/tree/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 From e37ad7a309dcd7ed8544bc0cc39eb65d7ea63c13 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Fri, 15 Aug 2025 11:41:26 +0100 Subject: [PATCH 6/8] Update kyc-tenure.yaml --- code/API_definitions/kyc-tenure.yaml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/code/API_definitions/kyc-tenure.yaml b/code/API_definitions/kyc-tenure.yaml index 862efec..1017232 100644 --- a/code/API_definitions/kyc-tenure.yaml +++ b/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: From 5ed21ac2b816295e2e3277b7c3d8dc628f80967d Mon Sep 17 00:00:00 2001 From: Gilles Renoux <144710412+GillesInnov35@users.noreply.github.com> Date: Thu, 18 Sep 2025 10:29:48 +0200 Subject: [PATCH 7/8] Update README.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 52c1bb7..eb0c919 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Sandbox API Repository to describe, develop, document, and test the Tenure Servi ## Release Information -**The latest public release of CAMARA Tenure is release [r2.2](https://github.com/camaraproject/Tenure/tree/r2.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/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) From ac5c03725bfb61da866ff995808661f4745fcdab Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 18 Sep 2025 18:40:44 +0200 Subject: [PATCH 8/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eb0c919..756509a 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Sandbox API Repository to describe, develop, document, and test the Tenure Servi 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) +* Meetings and minutes see [KnowYourCustomer Meetings](https://lf-camaraproject.atlassian.net/wiki/x/I4DGB) * Mailing List * Subscribe / Unsubscribe to the mailing list of this Sub Project https://lists.camaraproject.org/g/sp-kyc * A message to the community of this Sub Project can be sent using