Merge pull request #167 from fernandopradocabrillo/r1.4

fernandopradocabrillo · web-flow · commit 73a7058ee19d · 2024-12-11T16:36:04.000+01:00
r1.4
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Table of Contents
 
+- [r1.4](#r14)
 - [r1.3](#r13)
 - [r1.2](#r12)
 - [r1.1](#r11)
@@ -16,6 +17,50 @@ 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.4
+
+## Release Notes
+
+This release contains the definition and documentation of
+* 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.1
+
+**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.4/code/API_definitions/kyc-match.yaml)
+    - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.4/code/API_definitions/kyc-match.yaml&nocors)
+    - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.4/code/API_definitions/kyc-match.yaml&nocors)
+
+**Main changes**
+- Update test plan and remove unneeded scenario
+- There are no changes to the API definitions and API version numbers compared to r1.3
+
+### Changed
+
+- Update test plan and remove unneeded scenario by @fernandopradocabrillo in https://github.com/camaraproject/KnowYourCustomer/pull/163
+
+## kyc-fill-in v0.2.0
+
+**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.4/code/API_definitions/kyc-fill-in.yaml)
+    - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.4/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.4/code/API_definitions/kyc-fill-in.yaml&nocors)
+
+**Main Changes**
+
+* No changes in kyc-fill-in in this release
+
+**Full Changelog**: https://github.com/camaraproject/KnowYourCustomer/compare/r1.3...r1.4
+
 # r1.3
 
 ## Release Notes
diff --git 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.3](https://github.com/camaraproject/KnowYourCustomer/tree/r1.3)**. The Release Tag is [r1.3](https://github.com/camaraproject/KnowYourCustomer/releases/tag/r1.3).
+* `NEW`:**The latest release of CAMARA Know Your customer is [r1.4](https://github.com/camaraproject/KnowYourCustomer/tree/r1.4)**. The Release Tag is [r1.4](https://github.com/camaraproject/KnowYourCustomer/releases/tag/r1.4).
   - Contains the following API definitions **with inline documentation**:
-    - 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)
+    - kyc-match: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.4/code/API_definitions/kyc-match.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.4/code/API_definitions/kyc-match.yaml&nocors) | [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.4/code/API_definitions/kyc-match.yaml&nocors)
+    - kyc-fill-in: [YAML spec file](https://github.com/camaraproject/KnowYourCustomer/blob/r1.4/code/API_definitions/kyc-fill-in.yaml) | [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/KnowYourCustomer/r1.4/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.4/code/API_definitions/kyc-fill-in.yaml&nocors)
 
 ## Contributing
 
diff --git a/documentation/API_documentation/kyc-fill-in-API-Readiness-Checklist.md b/documentation/API_documentation/kyc-fill-in-API-Readiness-Checklist.md
@@ -9,8 +9,8 @@ Checklist for kyc-fill-in 0.2.0 in release r1.3
 |  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   |      |
 |  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-fill-in.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-fill-in.feature) |
+|  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-fill-in.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   |      |
diff --git a/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md b/documentation/API_documentation/kyc-match-API-Readiness-Checklist.md
@@ -9,8 +9,8 @@ Checklist for kyc-match 0.2.1 in release r1.3
 |  3 | Guidelines from ICM applied                  |   O   |         M         |    M    |    M   |  Y   |      |
 |  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)  |
+|  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   |  N   |      |
 |  9 | Test result statement                        |   O   |         O         |    O    |    M   |  N   |      |
 | 10 | API release numbering convention applied     |   M   |         M         |    M    |    M   |  Y   |      |
