From 0adee41039777a004d1c18b51f95eebca7394f25 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 11 Sep 2024 13:46:59 +0200 Subject: [PATCH 1/9] update version --- code/API_definitions/kyc-match.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/kyc-match.yaml b/code/API_definitions/kyc-match.yaml index fd5bacb..26474e5 100644 --- a/code/API_definitions/kyc-match.yaml +++ b/code/API_definitions/kyc-match.yaml @@ -51,7 +51,7 @@ info: license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html - version: wip + version: 0.2.1 x-camara-commonalities: 0.4.0 From 6319fd225be70630098d1c41770d9059a230fb71 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 11 Sep 2024 13:47:13 +0200 Subject: [PATCH 2/9] update changelog --- CHANGELOG.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ebb8c9..53c1bba 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of Contents +- [r1.3](#r13) - [r1.2](#r12) - [r1.1](#r11) - [v0.1.1](#v011) @@ -15,26 +16,28 @@ The below sections record the changes for each API version in each release as fo * 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 +# r1.3 ## Release Notes This release contains the definition and documentation of -* kyc-match v0.2.0 +* kyc-match v0.2.1 * kyc-fill-in v0.2.0 The API definition(s) are based on * Commonalities v0.4.0 * Identity and Consent Management v0.2.0 -## kyc-match v0.2.0 +## kyc-match v0.2.1 + +**NOTE: kyc-match v0.2.0 has been revoked and should not be considered due to a bug found in matchScore response property that makes this version not suitable. It is fixed in v0.2.1** -**kyc-match v0.2.0 is the first initial version for the CAMARA KnowYourCustomer Match API** +**kyc-match v0.2.1 is the first initial version for the CAMARA KnowYourCustomer Match API** - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.2/code/API_definitions/kyc-match.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-match.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-match.yaml&nocors) + - OpenAPI [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.3/code/API_definitions/kyc-match.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-match.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-match.yaml&nocors) **Main changes** - Includes Score functionality @@ -52,7 +55,7 @@ The API definition(s) are based on ### Fixed -* n/a +* Fix score type and change version by @fernandopradocabrillo in https://github.com/camaraproject/KnowYourCustomer/pull/148 ### Removed @@ -63,9 +66,9 @@ The API definition(s) are based on **kyc-fill-in v0.2.0 is the first initial version for the CAMARA KnowYourCustomer Fill-in API** - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.2/code/API_definitions/kyc-fill-in.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-fill-in.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-fill-in.yaml&nocors) + - OpenAPI [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.3/code/API_definitions/kyc-fill-in.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-fill-in.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-fill-in.yaml&nocors) **Main Changes** @@ -91,6 +94,10 @@ The API definition(s) are based on * n/a +# r1.2 + +**NOTE: Release r1.2 has been revoked due to a bug found in kyc-match v0.2.0 code. It is fixed in kyc-match v0.2.1 as part of r1.3 release.** + # r1.1 ## Release Notes From db027bb308945ff78a96f518daec23b4e8c3e0d7 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 11 Sep 2024 13:53:08 +0200 Subject: [PATCH 3/9] update README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ee4cb1e..6d2b094 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,10 @@ Repository to describe, develop, document and test the KnowYourCustomer API fami * 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`:**The latest release of CAMARA Know Your customer is [r1.2](https://github.com/camaraproject/KnowYourCustomer/tree/r1.2)**. The Release Tag is [r1.2](https://github.com/camaraproject/KnowYourCustomer/releases/tag/r1.2). +* `NEW`:**The latest release of CAMARA Know Your customer is [r1.3](https://github.com/camaraproject/KnowYourCustomer/tree/r1.3)**. The Release Tag is [r1.3](https://github.com/camaraproject/KnowYourCustomer/releases/tag/r1.3). - Contains the following API definitions **with inline documentation**: - - kyc-match: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.2/code/API_definitions/kyc-match.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-match.yaml&nocors) | [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-match.yaml&nocors) - - kyc-fill-in: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.2/code/API_definitions/kyc-fill-in.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-fill-in.yaml&nocors) | [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.2/code/API_definitions/kyc-fill-in.yaml&nocors) + - kyc-match: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.3/code/API_definitions/kyc-match.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-match.yaml&nocors) | [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-match.yaml&nocors) + - kyc-fill-in: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.3/code/API_definitions/kyc-fill-in.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-fill-in.yaml&nocors) | [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.3/code/API_definitions/kyc-fill-in.yaml&nocors) ## Contributing From b4a3442caffd98e0f5199b2b93c5197f5bb43d05 Mon Sep 17 00:00:00 2001 From: Fernando Prado Date: Wed, 11 Sep 2024 13:53:43 +0200 Subject: [PATCH 4/9] update test definitions version --- code/Test_definitions/kyc-match.feature | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/kyc-match.feature b/code/Test_definitions/kyc-match.feature index 0958fb6..c50c0a4 100644 --- a/code/Test_definitions/kyc-match.feature +++ b/code/Test_definitions/kyc-match.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Know Your Customer Match API, v0.2.0 - Operation KYC_Match +Feature: CAMARA Know Your Customer Match API, v0.2.1 - Operation KYC_Match # Input to be provided by the implementation to the tester # # Implementation indications: @@ -7,7 +7,7 @@ Feature: CAMARA Know Your Customer Match API, v0.2.0 - Operation KYC_Match # 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 0.2.0 + # References to OAS spec schemas refer to schemas specifies in kyc-match.yaml, version 0.2.1 Background: Common KYC_Match setup Given an environment at "apiRoot" From 2d6246687d4970d7fcc2cc18051d076feba7643f Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 12 Sep 2024 08:10:10 +0200 Subject: [PATCH 5/9] Update kyc-fill-in-API-Readiness-Checklist.md --- .../API_documentation/kyc-fill-in-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/kyc-fill-in-API-Readiness-Checklist.md b/documentation/API_documentation/kyc-fill-in-API-Readiness-Checklist.md index e1c2ae4..5adefbb 100644 --- a/documentation/API_documentation/kyc-fill-in-API-Readiness-Checklist.md +++ b/documentation/API_documentation/kyc-fill-in-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for kyc-fill-in 0.2.0 in release r1.2 +Checklist for kyc-fill-in 0.2.0 in release r1.3 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 0bb2082774ad4039bd69cbf99346e60af4ff0ef1 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 12 Sep 2024 08:10:31 +0200 Subject: [PATCH 6/9] Update kyc-match-API-Readiness-Checklist.md --- .../API_documentation/kyc-match-API-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md b/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md index dff0b48..2527423 100644 --- a/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md +++ b/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for kyc-match 0.2.0 in release r1.2 +Checklist for kyc-match 0.2.1 in release r1.3 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From c45a5c5965917f2cf860b9a93e2b5cb99eb7ba1a Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 12 Sep 2024 08:11:42 +0200 Subject: [PATCH 7/9] Delete code/API_definitions/README.MD --- code/API_definitions/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 code/API_definitions/README.MD diff --git a/code/API_definitions/README.MD b/code/API_definitions/README.MD deleted file mode 100644 index 04313f1..0000000 --- a/code/API_definitions/README.MD +++ /dev/null @@ -1 +0,0 @@ -Here you can add your definitions and delete this README.MD file From 7724e0992ea3f3387510f29ee15cc91bb923a3f9 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 12 Sep 2024 08:13:22 +0200 Subject: [PATCH 8/9] Delete documentation/API_documentation/README.MD --- documentation/API_documentation/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 documentation/API_documentation/README.MD diff --git a/documentation/API_documentation/README.MD b/documentation/API_documentation/README.MD deleted file mode 100644 index 37aa0ff..0000000 --- a/documentation/API_documentation/README.MD +++ /dev/null @@ -1 +0,0 @@ -This README.MD can be deleted when the first file is added to this directory. From 17402117f276ada5a581c1b212dba37a438b42c8 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 12 Sep 2024 09:15:13 +0200 Subject: [PATCH 9/9] Delete documentation/SupportingDocuments/README.MD --- documentation/SupportingDocuments/README.MD | 1 - 1 file changed, 1 deletion(-) delete mode 100644 documentation/SupportingDocuments/README.MD diff --git a/documentation/SupportingDocuments/README.MD b/documentation/SupportingDocuments/README.MD deleted file mode 100644 index 37aa0ff..0000000 --- a/documentation/SupportingDocuments/README.MD +++ /dev/null @@ -1 +0,0 @@ -This README.MD can be deleted when the first file is added to this directory.