From cc1b807fd9ae2356016cfe8fff187b42a8ae4a9e Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Mon, 22 Jul 2024 15:40:21 +0200 Subject: [PATCH 1/5] Update kyc-match.yaml Modifying info and servers object according to API Design Guidelines --- code/API_definitions/kyc-match.yaml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/code/API_definitions/kyc-match.yaml b/code/API_definitions/kyc-match.yaml index 46a18c9..bfe4b32 100644 --- a/code/API_definitions/kyc-match.yaml +++ b/code/API_definitions/kyc-match.yaml @@ -45,29 +45,23 @@ info: It is important to remark that in cases where personal user 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 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. - termsOfService: http://swagger.io/terms/ - contact: - email: project-email@sample.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: wip + x-camara-commonalities: 0.4.0 servers: - - url: '{apiRoot}/{basePath}' + - url: '{apiRoot}/kyc-match/v0.2' variables: apiRoot: default: http://localhost:9091 description: API root - basePath: - default: kyc-match/v0 - description: Base path for the KYC-Match API tags: - name: Match - description: Operations to match a customer identity against the account data bound to their phone number. paths: From 0ed39a27450e0c95eb8bd9cf0daccbede038ef9a Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Mon, 22 Jul 2024 15:42:51 +0200 Subject: [PATCH 2/5] Update kyc-fill-in.yaml Modifying info and servers object according to API Design Guidelines --- code/API_definitions/kyc-fill-in.yaml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/code/API_definitions/kyc-fill-in.yaml b/code/API_definitions/kyc-fill-in.yaml index b29ae46..dc27d99 100644 --- a/code/API_definitions/kyc-fill-in.yaml +++ b/code/API_definitions/kyc-fill-in.yaml @@ -49,25 +49,19 @@ info: It is important to remark that in cases where personal user 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 3-legged access tokens becomes mandatory. This measure ensures that the API remains in strict compliance with user privacy preferences and regulatory obligations, upholding the principles of transparency and user-centric data control. - - termsOfService: http://swagger.io/terms/ - contact: - email: project-email@sample.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: wip + x-camara-commonalities: 0.4.0 servers: - - url: '{apiRoot}/{basePath}' + - url: '{apiRoot}/kyc-fill-in/v0.1' variables: apiRoot: default: http://localhost:9091 description: API root - basePath: - default: kyc-fill-in/v0 - description: Base path for the KYC-Fill-in API tags: - name: Fill-in From b3647313344727777b26e460e661cf04a59c1135 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Mon, 22 Jul 2024 21:04:54 +0200 Subject: [PATCH 3/5] Update kyc-fill-in.yaml Security scope names according API Design Guidellines https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#1161-scope-naming --- code/API_definitions/kyc-fill-in.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/kyc-fill-in.yaml b/code/API_definitions/kyc-fill-in.yaml index dc27d99..ddc93c7 100644 --- a/code/API_definitions/kyc-fill-in.yaml +++ b/code/API_definitions/kyc-fill-in.yaml @@ -78,7 +78,7 @@ paths: security: - openId: - - know-your-customer:fill-in + - kyc-fill-in:fill-in parameters: - $ref: '#/components/parameters/x-correlator' From ddcf05ec0637dc5b83929ea032ef1e79beaed881 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Mon, 22 Jul 2024 21:05:08 +0200 Subject: [PATCH 4/5] Update kyc-match.yaml Security scope names according API Design Guidellines https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#1161-scope-naming --- 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 bfe4b32..f41f726 100644 --- a/code/API_definitions/kyc-match.yaml +++ b/code/API_definitions/kyc-match.yaml @@ -75,7 +75,7 @@ paths: security: - openId: - - know-your-customer:match + - kyc-match:match parameters: From d95621c4f38f426069a1cf4ce09370b90752a210 Mon Sep 17 00:00:00 2001 From: Rafal Artych <121048129+rartych@users.noreply.github.com> Date: Wed, 24 Jul 2024 09:08:54 +0200 Subject: [PATCH 5/5] Apply suggestions from code review urls in servers object corrected to vwip Co-authored-by: Herbert Damker --- code/API_definitions/kyc-fill-in.yaml | 3 ++- code/API_definitions/kyc-match.yaml | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/kyc-fill-in.yaml b/code/API_definitions/kyc-fill-in.yaml index ddc93c7..54bda8e 100644 --- a/code/API_definitions/kyc-fill-in.yaml +++ b/code/API_definitions/kyc-fill-in.yaml @@ -57,7 +57,8 @@ info: x-camara-commonalities: 0.4.0 servers: - - url: '{apiRoot}/kyc-fill-in/v0.1' + - url: '{apiRoot}/kyc-fill-in/vwip' + variables: apiRoot: default: http://localhost:9091 diff --git a/code/API_definitions/kyc-match.yaml b/code/API_definitions/kyc-match.yaml index f41f726..9106b66 100644 --- a/code/API_definitions/kyc-match.yaml +++ b/code/API_definitions/kyc-match.yaml @@ -54,7 +54,7 @@ info: servers: - - url: '{apiRoot}/kyc-match/v0.2' + - url: '{apiRoot}/kyc-match/vwip' variables: apiRoot: default: http://localhost:9091