diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e18ee4..d95f1e2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,8 @@ ## Table of Contents -- **[r1.1](#r11)** +- **[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.** @@ -16,6 +17,44 @@ The below sections record the changes for each API version in each release as fo **A previous changelog for this API can be found here: https://github.com/camaraproject/KnowYourCustomer/blob/main/CHANGELOG.md** +# r1.2 + +## Release Notes + +This public release contains the definition and documentation of: +* know-your-customer-match v0.4.0 + +The API definition(s) are based on +* Commonalities v0.6.0 [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) +* Identity and Consent Management v0.4.0 [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) + +## know-your-customer-match v0.4.0 +This is the latest public release for the CAMARA KnowYourCustomer Match API, updating the previous release to the CAMARA Guidelines and Identity & Consent Management for the Meta Release Fall25. Some new input paramenters, to be matched, have been introduced. + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/KnowYourCustomerMatch/blob/r1.2/code/API_definitions/kyc-match.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml) + +### Added + * Support for the following use attributes to be matched: https://github.com/camaraproject/KnowYourCustomerMatch/pull/24 + * Undocumented Errors note in info.description: https://github.com/camaraproject/KnowYourCustomerMatch/pull/18 + +### Changed + * Update x-correlator format: https://github.com/camaraproject/KnowYourCustomerMatch/pull/16 + +### Fixed + * Fixed the missing externalDocs object and the order of two lines (version, commonalities version) by @ToshiWakayama-KDDI in PR#33 (M4 Release PR) https://github.com/camaraproject/KnowYourCustomerMatch/pull/33 + * Fixed the new issues post M3 to meet M4 by @FabrizioMoggio in PR#28 (Wip for M4) https://github.com/camaraproject/KnowYourCustomerMatch/pull/28 + +### Removed + * Removed AUTHENTICATION_REQUIRED error code: https://github.com/camaraproject/KnowYourCustomerMatch/pull/19 + * Removed wrong value in test plan by @fernandopradocabrillo in PR#26 https://github.com/camaraproject/KnowYourCustomerMatch/pull/26 + +**Full Changelog**: https://github.com/camaraproject/KnowYourCustomerMatch/commits/r1.1...r1.2 + + + # r1.1 ## Release Notes @@ -46,7 +85,7 @@ This is the a release candidate for the CAMARA KnowYourCustomer Match API, updat * Undocumented Errors note in info.description: https://github.com/camaraproject/KnowYourCustomerMatch/pull/18 ### Changed - * x-correlator new format: https://github.com/camaraproject/CallForwardingSignal/pull/180, https://github.com/camaraproject/CallForwardingSignal/pull/186 + * Update x-correlator format: https://github.com/camaraproject/KnowYourCustomerMatch/pull/16 ### Fixed diff --git a/README.md b/README.md index 0c462d3..8e48cf8 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,18 @@ Incubating API Repository to evolve and maintain the definitions and documentati * 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. -* **NEW: Pre-release of CAMARA KYC Match is [r1.1](https://github.com/camaraproject/KnowYourCustomerMatch/tree/r1.1)**. The Release Tag is [r1.1](https://github.com/camaraproject/KnowYourCustomerMatch/releases/tag/r1.1). +* **NEW**: The latest public release of CAMARA KYC Match is [r1.2](https://github.com/camaraproject/KnowYourCustomerMatch/releases/tag/r1.2), with the following API version: -**Releases of the KnowYourCustomerMatch API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).** +* kyc-match v0.4.0 -For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerMatch/blob/main/CHANGELOG.md) +* API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/KnowYourCustomerMatch/blob/r1.2/code/API_definitions/kyc-match.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomerMatch/r1.2/code/API_definitions/kyc-match.yaml&nocors) + +* **Releases of the KnowYourCustomerMatch API until Spring25 are available in [KnowYourCustomer](https://github.com/camaraproject/KnowYourCustomer).** + +* For changes see [CHANGELOG.md](https://github.com/camaraproject/KnowYourCustomerMatch/blob/main/CHANGELOG.md) ## Contributing diff --git a/code/API_definitions/kyc-match.yaml b/code/API_definitions/kyc-match.yaml index 9cdde43..b332e78 100644 --- a/code/API_definitions/kyc-match.yaml +++ b/code/API_definitions/kyc-match.yaml @@ -25,7 +25,7 @@ info: The following figure is the generic high-level flows of this API. - KYC_Match_flow + KYC_Match_flow Note: @@ -63,16 +63,19 @@ info: 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. + version: 0.4.0 + x-camara-commonalities: 0.6 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip - x-camara-commonalities: 0.6 +externalDocs: + description: Product documentation at CAMARA + url: https://github.com/camaraproject/KnowYourCustomerMatch servers: - - url: '{apiRoot}/kyc-match/vwip' + - url: '{apiRoot}/kyc-match/v0.4' variables: apiRoot: default: http://localhost:9091 diff --git a/code/Test_definitions/kyc-match.feature b/code/Test_definitions/kyc-match.feature index 8537c6e..727ec9c 100644 --- a/code/Test_definitions/kyc-match.feature +++ b/code/Test_definitions/kyc-match.feature @@ -1,17 +1,18 @@ -Feature: CAMARA Know Your Customer Match API, vwip - Operation KYC_Match +Feature: CAMARA Know Your Customer Match API, v0.4.0 - Operation KYC_Match # Input to be provided by the implementation to the tester # # Implementation indications: + # * apiRoot: API root of the server URL # * Whether or not the idDocument request body property is mandatory. # # Testing assets: # * A mobile line identified by its phone number "phoneNumber" # - # References to OAS spec schemas refer to schemas specifies in kyc-match.yaml, version wip + # References to OAS spec schemas refer to schemas specifies in kyc-match.yaml, version 0.4.0 Background: Common KYC_Match setup Given an environment at "apiRoot" - And the resource "/kyc-match/vwip/match" + And the resource "/kyc-match/v0.4/match" 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" @@ -341,4 +342,4 @@ Feature: CAMARA Know Your Customer Match API, vwip - Operation KYC_Match Then the response status code is 422 And the response property "$.status" is 422 And the response property "$.code" is "SERVICE_NOT_APPLICABLE" - And the response property "$.message" contains a user friendly text \ No newline at end of file + And the response property "$.message" contains a user friendly text diff --git a/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md b/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md index f59bbcb..8594976 100644 --- a/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md +++ b/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md @@ -1,19 +1,19 @@ # API Readiness Checklist -Checklist for kyc-match 0.4.0-rc.1 in release r1.1 +Checklist for kyc-match 0.4.0 in release r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/kyc-match.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 - [link](/code/API_definitions/kyc-match.yaml) | | 6 | User stories | O | O | O | M | Y | [link](/documentation/API_documentation/KnowYourCustomer_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions/kyc-match.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](/code/Test_definitions/kyc-match.feature) | | 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 | r1.2 | | 11 | Change log updated | M | M | M | M | Y | [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/RwAzC) |