Skip to content

Commit

Permalink
Merge pull request camaraproject#149 from fernandopradocabrillo/r1.3
Browse files Browse the repository at this point in the history
Public Release for Fall24 meta-release r1.3
  • Loading branch information
fernandopradocabrillo authored Sep 12, 2024
2 parents bfb3276 + 1740211 commit a2575b0
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 22 deletions.
29 changes: 18 additions & 11 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Table of Contents

- [r1.3](#r13)
- [r1.2](#r12)
- [r1.1](#r11)
- [v0.1.1](#v011)
Expand All @@ -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
Expand All @@ -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

Expand All @@ -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**

Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion code/API_definitions/README.MD

This file was deleted.

2 changes: 1 addition & 1 deletion code/API_definitions/kyc-match.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions code/Test_definitions/kyc-match.feature
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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"
Expand Down
1 change: 0 additions & 1 deletion documentation/API_documentation/README.MD

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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<br>public | stable<br> public | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
Expand Down
Original file line number Diff line number Diff line change
@@ -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<br>public | stable<br> public | Status | Comments |
|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:|
Expand Down
1 change: 0 additions & 1 deletion documentation/SupportingDocuments/README.MD

This file was deleted.

0 comments on commit a2575b0

Please sign in to comment.