From 86aa49f3f3de2233b328c666b439e30d76e2878b Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 26 Aug 2024 13:56:49 +0200 Subject: [PATCH 01/30] Update number_verification.yaml Set version to 1.0.0 --- code/API_definitions/number_verification.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/number_verification.yaml b/code/API_definitions/number_verification.yaml index 60f8a86..ef009f2 100644 --- a/code/API_definitions/number_verification.yaml +++ b/code/API_definitions/number_verification.yaml @@ -50,13 +50,13 @@ info: # Further info and support [GSMA Mobile Connect Verified MSISDN specification](https://www.gsma.com/identity/wp-content/uploads/2022/12/IDY.54-Mobile-Connect-Verified-MSISDN-Definition-and-Technical-Requirements-1.0.pdf) was used as source of input for this API. For more about Mobile Connect, please see [Mobile Connect website](https://mobileconnect.io/). - version: wip + version: 1.0.0 x-camara-commonalities: 0.4.0 license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - - url: '{apiRoot}/number-verification/v1rc1' + - url: '{apiRoot}/number-verification/v1' variables: apiRoot: default: http://localhost:9091 From 0d3eef66d5400db8ba7ae66d1781aa033624cc96 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 26 Aug 2024 14:04:49 +0200 Subject: [PATCH 02/30] Update NumberVerification-Readiness-Checklist.md Update Readiness Checklist --- .../NumberVerification-Readiness-Checklist.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index d00b0b8..d6166b7 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -1,6 +1,6 @@ # API Readiness Checklist -Checklist for number_verification 1.0.0-rc.1 in release r1.1 +Checklist for number_verification 1.0.0 in release r1.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| @@ -9,14 +9,13 @@ Checklist for number_verification 1.0.0-rc.1 in release r1.1 | 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 | Embed documentation into API spec - [link](/code/API_definitions/number_verification.yaml) | -| 6 | User stories | O | O | O | M | tbd | [PR #129](https://github.com/camaraproject/NumberVerification/pull/129/files) | -| 7 | Basic API test cases & documentation | O | M | M | M | tbd | [PR #124](https://github.com/camaraproject/NumberVerification/pull/124/files) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | tbd | [PR #124](https://github.com/camaraproject/NumberVerification/pull/124/files) | -| 9 | Test result statement | O | O | O | M | tbd | link | - +| 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [PR #124](https://github.com/camaraproject/NumberVerification/pull/124/files) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [PR #124](https://github.com/camaraproject/NumberVerification/pull/124/files) | +| 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | -| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) | -| 12 | Previous public-release was certified | O | O | O | M | Y | | +| 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | +| 12 | Previous public-release was certified | O | O | O | M | Y | [link](https://www.open-gateway.com/operators-map) | To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. From dc2f6b3e2a02e0cfa58e32dd6040caa8f52ef8aa Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 26 Aug 2024 14:09:58 +0200 Subject: [PATCH 03/30] Update README.md Update readme for r1.2 --- README.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bc5754e..9760c0f 100644 --- a/README.md +++ b/README.md @@ -27,19 +27,15 @@ Repository to describe, develop, document and test the NumberVerification API fa ## Status and released versions * Note: 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 a new release is created. For example, changes may be reverted before a release is created. **For best results, use the latest available release**. -* **The latest pre-release of CAMARA Number Verification API is 1.0.0-rc.1 This is the release candidate of the first stable version of the API**. It is suitable for implementors. -* The Release Tag is [r1.1](https://github.com/camaraproject/NumberVerification/releases/tag/r1.1). - - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.1/code/API_definitions/number_verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.1/code/API_definitions/number_verification.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.1/code/API_definitions/number_verification.yaml) - -* The previous version 0.3.1 is available within the [release-0.3.1 branch](https://github.com/camaraproject/NumberVerification/tree/release-0.3.1): +* `NEW`: Release r1.2 with version 1.0.0 of the API number_verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r1.2) - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/release-0.3.1/code/API_definitions/CAMARA/number_verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/release-0.3.1/code/API_definitions/CAMARA/number_verification.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/release-0.3.1/code/API_definitions/CAMARA/number_verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.2/code/API_definitions/number_verification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml) + +* Previous releases and pre-releases of the repository are available in https://github.com/camaraproject/NumberVerification/releases +* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberVerification/blob/main/CHANGELOG.md) ## Contributorship and mailing list From 06176c9cd153bacba2b99326e645bbbef61a4114 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 26 Aug 2024 14:18:04 +0200 Subject: [PATCH 04/30] Update CHANGELOG.md Update changelog for r1.2 --- CHANGELOG.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 52 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 14e9e60..da3e9cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,12 +3,63 @@ ## Table of contents +- **[r1.2](#r12)** - **[r1.1](#r11)** -- [v0.3.1](#v031) +- **[v0.3.1](#v031)** **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.** +# r1.2 + +## Release Notes + +This release contains the definition and documentation of +* number_verification 1.0.0 + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 + +## number_verification 1.0.0 + +**number_verification 1.0.0 is the public release for v1.0.0 of the NumberVerification API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.2/code/API_definitions/number_verification.yaml) + +**Main Changes** + +* API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release +* Additional documentation & test cases added. + + +### Added + +* User Story in documentation/API_documentation directory by @bigludo7 [PR118](https://github.com/camaraproject/NumberVerification/pull/118) +* Test Definition in Test_Definitions directory by @AxelNennker [PR124](https://github.com/camaraproject/NumberVerification/pull/124) + +### Changed + +* Aligned with CAMARA design guidelines & Identity Consent management by @AxelNennker +* Make the '+' mandatory for the phone number by @fernandopradocabrillo [PR90](https://github.com/camaraproject/NumberVerification/pull/90) +* Cosmetic change following megalinter integration by @bigludo7 [PR103](https://github.com/camaraproject/NumberVerification/pull/103) +* Update Authorization and authentication part accordingly to ICM by @fernandopradocabrillo [PR88](https://github.com/camaraproject/NumberVerification/issues/88) +* Adding a pattern for PhoneNumber in /verify by @maxl2287 [PR68](https://github.com/camaraproject/NumberVerification/issues/76) +* Clarify use of 'user' and 'subscriber' wording by @AxelNennker [PR102](https://github.com/camaraproject/NumberVerification/pull/102) + +### Fixed + +* Replaced OAuth2 auth code flow by OIDC auth code flow by @AxelNennker [PR109](https://github.com/camaraproject/NumberVerification/pull/109) + +### Removed + +* Removed documentation (replaced by doc in the yaml) by @AxelNennker [PR137](https://github.com/camaraproject/NumberVerification/pull/1379) + +## New Contributors +* N/A # r1.1 - rc From 41d7cc807f3a70ccfd5400e65788d4f1bb023494 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 26 Aug 2024 14:18:36 +0200 Subject: [PATCH 05/30] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index da3e9cb..c6b4e8b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ## Table of contents - **[r1.2](#r12)** -- **[r1.1](#r11)** +- **[r1.1](#r11-rc)** - **[v0.3.1](#v031)** From f212048b7a55c461f889407cef7c440d5a09f118 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Mon, 26 Aug 2024 14:19:06 +0200 Subject: [PATCH 06/30] Update CHANGELOG.md --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6b4e8b..20b243a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,7 @@ ## Table of contents - **[r1.2](#r12)** -- **[r1.1](#r11-rc)** +- **[r1.1](#r11)** - **[v0.3.1](#v031)** @@ -62,7 +62,7 @@ The API definition(s) are based on * N/A -# r1.1 - rc +# r1.1 ## Release Notes From 936209349868bc1bd33c39e58284ce73bc8f4297 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 27 Aug 2024 14:10:59 +0200 Subject: [PATCH 07/30] Update NumberVerification-Readiness-Checklist.md Add link for the test definition --- .../NumberVerification-Readiness-Checklist.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index d6166b7..420a89e 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -10,8 +10,8 @@ Checklist for number_verification 1.0.0 in release r1.2 | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/number_verification.yaml) | | 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [PR #124](https://github.com/camaraproject/NumberVerification/pull/124/files) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [PR #124](https://github.com/camaraproject/NumberVerification/pull/124/files) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](/code/Test_Definitions/NumberVerification_device_phone_number_share.feature) [verify](/code/Test_Definitions/NumberVerification_verify.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](https://github.com/camaraproject/NumberVerification/pull/124/files) | | 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | From 516ce18cfc84d9a5cb6afb32a97a3a85dd48388c Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 27 Aug 2024 16:06:06 +0200 Subject: [PATCH 08/30] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 20b243a..efbae85 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ The API definition(s) are based on ## number_verification 1.0.0 -**number_verification 1.0.0 is the public release for v1.0.0 of the NumberVerification API.** +**number_verification 1.0.0 is the release of the first stable version of the NumberVerification API.** - API definition **with inline documentation**: - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml&nocors) From d63676de477a7f2f8f9976ba9461074c21a8ea87 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 27 Aug 2024 16:10:28 +0200 Subject: [PATCH 09/30] Update NumberVerification-Readiness-Checklist.md --- .../API_documentation/NumberVerification-Readiness-Checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index 420a89e..1856d49 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -11,7 +11,7 @@ Checklist for number_verification 1.0.0 in release r1.2 | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/number_verification.yaml) | | 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](/code/Test_Definitions/NumberVerification_device_phone_number_share.feature) [verify](/code/Test_Definitions/NumberVerification_verify.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [link](https://github.com/camaraproject/NumberVerification/pull/124/files) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](/code/Test_Definitions/NumberVerification_device_phone_number_share.feature) [verify](/code/Test_Definitions/NumberVerification_verify.feature) | | 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | From b640c9a0506c190b0dcdcb501f3b78356b3e342a Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 28 Aug 2024 13:27:51 +0200 Subject: [PATCH 10/30] Update README.md Fixed link to meeting minutes (last ine) Thanks @rartych --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9760c0f..73f35a0 100644 --- a/README.md +++ b/README.md @@ -46,4 +46,4 @@ Repository to describe, develop, document and test the NumberVerification API fa ## Relevant Information -Since April 4th 2024 WG meeting minutes are placed in [Number Verification Wiki Confluence site](https://wiki.camaraproject.org/display/CAM/Number+Verification) +Since April 4th 2024 WG meeting minutes are placed in [Number Verification Wiki Confluence site](https://wiki.camaraproject.org/display/CAM/NumberVerification) From e3eb206033f86de14a658ece3619c0c9f5288e34 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:44:16 +0200 Subject: [PATCH 11/30] Rename number_verification.yaml to number-verification.yaml --- .../{number_verification.yaml => number-verification.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/API_definitions/{number_verification.yaml => number-verification.yaml} (100%) diff --git a/code/API_definitions/number_verification.yaml b/code/API_definitions/number-verification.yaml similarity index 100% rename from code/API_definitions/number_verification.yaml rename to code/API_definitions/number-verification.yaml From d5a475b421f585886049a94a227200f4048b2614 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:45:06 +0200 Subject: [PATCH 12/30] Update NumberVerification_device_phone_number_share.feature --- .../NumberVerification_device_phone_number_share.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_Definitions/NumberVerification_device_phone_number_share.feature b/code/Test_Definitions/NumberVerification_device_phone_number_share.feature index 4d81091..37dc14b 100644 --- a/code/Test_Definitions/NumberVerification_device_phone_number_share.feature +++ b/code/Test_Definitions/NumberVerification_device_phone_number_share.feature @@ -5,7 +5,7 @@ Feature: Camara Number Verification API device phone number share # Input to be provided by the implementation to the tests # References to OAS spec schemas refer to schemas specified in -# https://raw.githubusercontent.com/camaraproject/NumberVerification/main/code/API_definitions/number_verification.yaml +# https://raw.githubusercontent.com/camaraproject/NumberVerification/main/code/API_definitions/number-verification.yaml # # Implementation indications: # * api_root: API root of the server URL From bbf0b6eb951e0807bc2f1e2632fdb58918076d8a Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:45:39 +0200 Subject: [PATCH 13/30] Update NumberVerification_verify.feature --- code/Test_Definitions/NumberVerification_verify.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_Definitions/NumberVerification_verify.feature b/code/Test_Definitions/NumberVerification_verify.feature index 542cdfb..51740a0 100644 --- a/code/Test_Definitions/NumberVerification_verify.feature +++ b/code/Test_Definitions/NumberVerification_verify.feature @@ -5,7 +5,7 @@ Feature: Camara Number Verification API verify # Input to be provided by the implementation to the tests # References to OAS spec schemas refer to schemas specified in -# https://raw.githubusercontent.com/camaraproject/NumberVerification/main/code/API_definitions/number_verification.yaml +# https://raw.githubusercontent.com/camaraproject/NumberVerification/main/code/API_definitions/number-verification.yaml # # Implementation indications: # * api_root: API root of the server URL From 75eb40a1f71d64b030d54dd9ea041616b2af0f7b Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:47:29 +0200 Subject: [PATCH 14/30] Update README.md Change number_verification to number-verification --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 73f35a0..08684e5 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@ Repository to describe, develop, document and test the NumberVerification API fa * Note: 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 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`: Release r1.2 with version 1.0.0 of the API number_verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r1.2) +* `NEW`: Release r1.2 with version 1.0.0 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r1.2) - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.2/code/API_definitions/number_verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.2/code/API_definitions/number-verification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number-verification.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number-verification.yaml) * Previous releases and pre-releases of the repository are available in https://github.com/camaraproject/NumberVerification/releases * For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberVerification/blob/main/CHANGELOG.md) From c7194aafdd2a76e4cd21d3555fffb3cf90d35887 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:49:59 +0200 Subject: [PATCH 15/30] Update CHANGELOG.md Change name from number_verification to number-verification --- CHANGELOG.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index efbae85..2f70a66 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,25 +15,26 @@ ## Release Notes This release contains the definition and documentation of -* number_verification 1.0.0 +* number-verification 1.0.0 The API definition(s) are based on * Commonalities v0.4.0 * Identity and Consent Management v0.2.0 -## number_verification 1.0.0 +## number-verification 1.0.0 -**number_verification 1.0.0 is the release of the first stable version of the NumberVerification API.** +**number-verification 1.0.0 is the release of the first stable version of the NumberVerification API.** - API definition **with inline documentation**: - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number_verification.yaml) - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.2/code/API_definitions/number_verification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number-verification.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r1.2/code/API_definitions/number-verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r1.2/code/API_definitions/number-verification.yaml) **Main Changes** * API and test definitions updated to conform to the Commonalities v0.4.0 and Identity and Consent Management v0.2.0 guidelines included in the CAMARA Fall24 meta-release * Additional documentation & test cases added. +* Changed name of the file itself from number_verification.yaml to number-verification.yaml ### Added From de14df7399b55184f6a3f8f42fb445e288ba57bd Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:53:50 +0200 Subject: [PATCH 16/30] Update NumberVerification-Readiness-Checklist.md Took into account file name change: number_verification.yaml to number-verification.yaml --- .../NumberVerification-Readiness-Checklist.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index 1856d49..df1e195 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -1,14 +1,14 @@ # API Readiness Checklist -Checklist for number_verification 1.0.0 in release r1.2 +Checklist for number-verification 1.0.0 in release r1.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/number_verification.yaml) | +| 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/number-verification.yaml) | | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | 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 | Embed documentation into API spec - [link](/code/API_definitions/number_verification.yaml) | +| 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/number-verification.yaml) | | 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](/code/Test_Definitions/NumberVerification_device_phone_number_share.feature) [verify](/code/Test_Definitions/NumberVerification_verify.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](/code/Test_Definitions/NumberVerification_device_phone_number_share.feature) [verify](/code/Test_Definitions/NumberVerification_verify.feature) | From 3498a3da66be210f72c619addc108fa7f9583c41 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 09:40:44 +0200 Subject: [PATCH 17/30] Update NumberVerification_device_phone_number_share.feature Changed reference path to the yaml. --- .../NumberVerification_device_phone_number_share.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_Definitions/NumberVerification_device_phone_number_share.feature b/code/Test_Definitions/NumberVerification_device_phone_number_share.feature index 37dc14b..7f59412 100644 --- a/code/Test_Definitions/NumberVerification_device_phone_number_share.feature +++ b/code/Test_Definitions/NumberVerification_device_phone_number_share.feature @@ -5,7 +5,7 @@ Feature: Camara Number Verification API device phone number share # Input to be provided by the implementation to the tests # References to OAS spec schemas refer to schemas specified in -# https://raw.githubusercontent.com/camaraproject/NumberVerification/main/code/API_definitions/number-verification.yaml +# /code/API_definitions/number-verification.yaml # # Implementation indications: # * api_root: API root of the server URL From fc93ac2f8b3433870ef0ea27f0a75d2067ad8773 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 09:41:10 +0200 Subject: [PATCH 18/30] Update NumberVerification_verify.feature Changed reference path to the yaml. --- code/Test_Definitions/NumberVerification_verify.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_Definitions/NumberVerification_verify.feature b/code/Test_Definitions/NumberVerification_verify.feature index 51740a0..7242cb9 100644 --- a/code/Test_Definitions/NumberVerification_verify.feature +++ b/code/Test_Definitions/NumberVerification_verify.feature @@ -5,7 +5,7 @@ Feature: Camara Number Verification API verify # Input to be provided by the implementation to the tests # References to OAS spec schemas refer to schemas specified in -# https://raw.githubusercontent.com/camaraproject/NumberVerification/main/code/API_definitions/number-verification.yaml +# /code/API_definitions/number-verification.yaml # # Implementation indications: # * api_root: API root of the server URL From 91d35e08d5d9d726c7143bb159af152a62a2a708 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 11:07:59 +0200 Subject: [PATCH 19/30] Update NumberVerification_verify.feature --- .../NumberVerification_verify.feature | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/code/Test_Definitions/NumberVerification_verify.feature b/code/Test_Definitions/NumberVerification_verify.feature index 7242cb9..95ea1e7 100644 --- a/code/Test_Definitions/NumberVerification_verify.feature +++ b/code/Test_Definitions/NumberVerification_verify.feature @@ -1,5 +1,3 @@ - - @NumberVerification_verify Feature: Camara Number Verification API verify @@ -16,8 +14,6 @@ Feature: Camara Number Verification API verify # * a mobile device with SIM card with NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER_HASHED1 # * a mobile device with SIM card with NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER_HASHED2 - - Background: Common Number Verification verify setup Given the resource "/number-verification/v0" as base url And the header "Content-Type" is set to "application/json" @@ -39,7 +35,7 @@ Feature: Camara Number Verification API verify And the response property "$.code" is "INVALID_ARGUMENT" And the response property "$.message" contains a user friendly text And they acquired a valid access token associated with NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER1 through OIDC authorization code flow - + Examples: | phone_number_value | | string_value | @@ -49,7 +45,6 @@ Feature: Camara Number Verification API verify | 123 | | ++49565456787 | - @NumberVerification_verify100_match_true Scenario: verify phone number NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER1, network connection and access token matches NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER1 Given they use the base url @@ -78,7 +73,6 @@ Feature: Camara Number Verification API verify Then the response status code is 200 And the response property "$.devicePhoneNumberVerified" is true - @NumberVerification_verify101_match_false Scenario: verify phone number NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER1 but access token is associated with NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER2 Given they use the base url @@ -157,7 +151,7 @@ Feature: Camara Number Verification API verify And the response property "$.message" is "New authentication is required." @NumberVerification_verify203_both_phone_number_and_hashed_in_request - Scenario: verify phone number but no phonenumber in request + Scenario: verify phone number but providing both plain and hashed phone number in the body Given they use the base url And the resource is "/verify" And one of the scopes associated with the access token is number-verification:verify @@ -188,7 +182,6 @@ Feature: Camara Number Verification API verify And the response property "$.status" is 403 And the response property "$.code" is "INVALID_TOKEN_CONTEXT" And the response property "$.message" is "Phone number cannot be deducted from access token context." - @NumberVerification_phone_number_verify205_must_have_used_network_authentication Scenario: verify phone number with valid access token but network authentication was not used From 23777bd7c07d169bdcdc7e4f217cb759bd0812c0 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 12:17:50 +0200 Subject: [PATCH 20/30] Rename NumberVerification_verify.feature to number-verification-verify.feature --- ...fication_verify.feature => number-verification-verify.feature} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename code/Test_Definitions/{NumberVerification_verify.feature => number-verification-verify.feature} (100%) diff --git a/code/Test_Definitions/NumberVerification_verify.feature b/code/Test_Definitions/number-verification-verify.feature similarity index 100% rename from code/Test_Definitions/NumberVerification_verify.feature rename to code/Test_Definitions/number-verification-verify.feature From 2d1e541053c5b59cbb560bf0fc10a4d96ac3ef9d Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 12:19:31 +0200 Subject: [PATCH 21/30] Update and rename NumberVerification_device_phone_number_share.feature to number-verification-device-phone-number-share.feature + make linting happy --- ...re => number-verification-device-phone-number-share.feature} | 2 -- 1 file changed, 2 deletions(-) rename code/Test_Definitions/{NumberVerification_device_phone_number_share.feature => number-verification-device-phone-number-share.feature} (99%) diff --git a/code/Test_Definitions/NumberVerification_device_phone_number_share.feature b/code/Test_Definitions/number-verification-device-phone-number-share.feature similarity index 99% rename from code/Test_Definitions/NumberVerification_device_phone_number_share.feature rename to code/Test_Definitions/number-verification-device-phone-number-share.feature index 7f59412..7985f89 100644 --- a/code/Test_Definitions/NumberVerification_device_phone_number_share.feature +++ b/code/Test_Definitions/number-verification-device-phone-number-share.feature @@ -1,5 +1,3 @@ - - @NumberVerification_device_phone_number_share Feature: Camara Number Verification API device phone number share From f5e1a0161c7733729f5c3731da2e2f96c7300ae7 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 29 Aug 2024 16:36:28 +0200 Subject: [PATCH 22/30] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../NumberVerification-Readiness-Checklist.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index df1e195..1482a2c 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -10,8 +10,9 @@ Checklist for number-verification 1.0.0 in release r1.2 | 4 | API versioning convention applied | M | M | M | M | Y | | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/number-verification.yaml) | | 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | -| 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](/code/Test_Definitions/NumberVerification_device_phone_number_share.feature) [verify](/code/Test_Definitions/NumberVerification_verify.feature) | -| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](/code/Test_Definitions/NumberVerification_device_phone_number_share.feature) [verify](/code/Test_Definitions/NumberVerification_verify.feature) | +| 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](code/Test_Definitions/number-verification-device-phone-number-share.feature) [verify](/code/Test_Definitions/number-verification-verify.feature) | +| 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](code/Test_Definitions/number-verification-device-phone-number-share.feature) [verify](code/Test_Definitions/number-verification-verify.feature) | + | 9 | Test result statement | O | O | O | M | N | link | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | From c19dbec2ccb749d8ec9bdabd564bd247b5f60887 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 30 Aug 2024 14:28:17 +0200 Subject: [PATCH 23/30] Update number-verification.yaml fixed X-Correlator to x-correlator. --- code/API_definitions/number-verification.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/code/API_definitions/number-verification.yaml b/code/API_definitions/number-verification.yaml index ef009f2..fd6067e 100644 --- a/code/API_definitions/number-verification.yaml +++ b/code/API_definitions/number-verification.yaml @@ -79,7 +79,7 @@ paths: operationId: phoneNumberVerify parameters: - in: header - name: X-Correlator + name: x-correlator required: false description: Correlation id for the different services schema: @@ -94,7 +94,7 @@ paths: '200': description: OK headers: - X-Correlator: + x-correlator: description: Correlation id for the different services schema: type: string @@ -129,7 +129,7 @@ paths: operationId: phoneNumberShare parameters: - in: header - name: X-Correlator + name: x-correlator required: false description: Correlation id for the different services schema: @@ -138,7 +138,7 @@ paths: '200': description: OK headers: - X-Correlator: + x-correlator: description: Correlation id for the different services schema: type: string From 85161c3af538a285cb4b074d0585d234de39ac8f Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:27:04 +0200 Subject: [PATCH 24/30] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md Co-authored-by: Jose Luis Urien --- .../NumberVerification-Readiness-Checklist.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index 1482a2c..1ea4866 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -8,7 +8,8 @@ Checklist for number-verification 1.0.0 in release r1.2 | 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | | | 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 | Embed documentation into API spec - [link](/code/API_definitions/number-verification.yaml) | +| 5 | API documentation | M | M | M | M | Y | Embedded documentation into API spec - [link](/code/API_definitions/number-verification.yaml) | + | 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](code/Test_Definitions/number-verification-device-phone-number-share.feature) [verify](/code/Test_Definitions/number-verification-verify.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](code/Test_Definitions/number-verification-device-phone-number-share.feature) [verify](code/Test_Definitions/number-verification-verify.feature) | From b988d0cf95928f2cb7de45ae9be23cb1be6c00dd Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:28:24 +0200 Subject: [PATCH 25/30] Update number-verification-device-phone-number-share.feature changed "/device-phone-number/v0" to "/device-phone-number/v1" --- .../number-verification-device-phone-number-share.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_Definitions/number-verification-device-phone-number-share.feature b/code/Test_Definitions/number-verification-device-phone-number-share.feature index 7985f89..c8b3e0d 100644 --- a/code/Test_Definitions/number-verification-device-phone-number-share.feature +++ b/code/Test_Definitions/number-verification-device-phone-number-share.feature @@ -13,7 +13,7 @@ Feature: Camara Number Verification API device phone number share # * a mobile device with SIM card with NUMBERVERIFY_SHARE_PHONENUMBER2 Background: Common Number Verification phone number share setup - Given the resource "/device-phone-number/v0" as base url + Given the resource "/device-phone-number/v1" as base url 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" is set to a UUID value From d5dc23e2bbe831fbaa6ca4e130207af00c928e81 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Tue, 3 Sep 2024 14:29:38 +0200 Subject: [PATCH 26/30] Update number-verification-verify.feature changed /number-verification/v0 to /number-verification/v1 in the background section --- code/Test_Definitions/number-verification-verify.feature | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/Test_Definitions/number-verification-verify.feature b/code/Test_Definitions/number-verification-verify.feature index 95ea1e7..22d6362 100644 --- a/code/Test_Definitions/number-verification-verify.feature +++ b/code/Test_Definitions/number-verification-verify.feature @@ -15,7 +15,7 @@ Feature: Camara Number Verification API verify # * a mobile device with SIM card with NUMBERVERIFY_VERIFY_MATCH_PHONENUMBER_HASHED2 Background: Common Number Verification verify setup - Given the resource "/number-verification/v0" as base url + Given the resource "/number-verification/v1" as base url 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" is set to a UUID value From 2733d6f947d85510d7aaafb0fdd6490ff22aa0f0 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 5 Sep 2024 09:16:23 +0200 Subject: [PATCH 27/30] Update number-verification.yaml Added sentences in doc as mentioned in #116 --- code/API_definitions/number-verification.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/code/API_definitions/number-verification.yaml b/code/API_definitions/number-verification.yaml index fd6067e..e65d7ce 100644 --- a/code/API_definitions/number-verification.yaml +++ b/code/API_definitions/number-verification.yaml @@ -30,6 +30,8 @@ info: # Sequence Diagram Number Verification API uses the **standard [OIDC Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)**. The following diagram will help to clarify the end-to-end process, including previous steps prior to this API call. + Note that the diagram shows just an example of a direct integration from developer's application and MNO's authserver and API, other scenarios of indirect integration via Aggregator/Channel Partner should also be considered. Specific authorization flows may apply, as defined by e.g. GSMA OGW + ![UML Sequence Diagram](https://raw.githubusercontent.com/camaraproject/NumberVerification/main/documentation/API_documentation/assets/uml_v0.3.jpg) **Additional details:** From a758096bb701a2bed215af2e6614cac476218ff0 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 5 Sep 2024 09:19:22 +0200 Subject: [PATCH 28/30] Update CHANGELOG.md Add a line to indicate that we updated the documentation part of the yaml --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2f70a66..3aa9479 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -50,6 +50,7 @@ The API definition(s) are based on * Update Authorization and authentication part accordingly to ICM by @fernandopradocabrillo [PR88](https://github.com/camaraproject/NumberVerification/issues/88) * Adding a pattern for PhoneNumber in /verify by @maxl2287 [PR68](https://github.com/camaraproject/NumberVerification/issues/76) * Clarify use of 'user' and 'subscriber' wording by @AxelNennker [PR102](https://github.com/camaraproject/NumberVerification/pull/102) +* Clarify that the sequence diagram in the yaml documentation is an example by @bigludo7 [PR139](https://github.com/camaraproject/NumberVerification/pull/139) ### Fixed From 4453998667c393b859030b28c1bd51968e29136d Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 5 Sep 2024 14:41:26 +0200 Subject: [PATCH 29/30] Update code/API_definitions/number-verification.yaml Co-authored-by: Herbert Damker --- code/API_definitions/number-verification.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code/API_definitions/number-verification.yaml b/code/API_definitions/number-verification.yaml index e65d7ce..886ae34 100644 --- a/code/API_definitions/number-verification.yaml +++ b/code/API_definitions/number-verification.yaml @@ -30,7 +30,7 @@ info: # Sequence Diagram Number Verification API uses the **standard [OIDC Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth)**. The following diagram will help to clarify the end-to-end process, including previous steps prior to this API call. - Note that the diagram shows just an example of a direct integration from developer's application and MNO's authserver and API, other scenarios of indirect integration via Aggregator/Channel Partner should also be considered. Specific authorization flows may apply, as defined by e.g. GSMA OGW + Note that the diagram shows just an example of a direct integration from developer's application and MNO's authserver and API, other scenarios of indirect integration via Aggregator/Channel Partner should also be considered. Specific authorization flows may apply, as defined by e.g. GSMA Open Gateway (OGW). ![UML Sequence Diagram](https://raw.githubusercontent.com/camaraproject/NumberVerification/main/documentation/API_documentation/assets/uml_v0.3.jpg) From b3d50438912c4f63ee60eabfad0a5ff1e72d4fed Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 5 Sep 2024 18:34:12 +0200 Subject: [PATCH 30/30] Update NumberVerification-Readiness-Checklist.md Taking care of the Test result statement accordingly to https://github.com/camaraproject/ReleaseManagement/issues/89 --- .../NumberVerification-Readiness-Checklist.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index 1ea4866..dfaa598 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -9,16 +9,17 @@ Checklist for number-verification 1.0.0 in release r1.2 | 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/number-verification.yaml) | - | 6 | User stories | O | O | O | M | Y | [get](/documentation/API_documentation/NumberVerification_device_phone_number_User_Story.md) [verify](/documentation/API_documentation/NumberVerification_verify_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [get](code/Test_Definitions/number-verification-device-phone-number-share.feature) [verify](/code/Test_Definitions/number-verification-verify.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](code/Test_Definitions/number-verification-device-phone-number-share.feature) [verify](code/Test_Definitions/number-verification-verify.feature) | - -| 9 | Test result statement | O | O | O | M | N | link | +| 9 | Test result statement | O | O | O | M | N | Fall24 EXCEPTION: Test results not available (*) | | 10 | API release numbering convention applied | M | M | M | M | Y | | | 11 | Change log updated | M | M | M | M | Y | [link](/CHANGELOG.md) | | 12 | Previous public-release was certified | O | O | O | M | Y | [link](https://www.open-gateway.com/operators-map) | +(*) If you encounter issues with the provided test files (.feature), please create an issue in the API Sub-Project to signal these issues so they can be fixed in a patch release. + + To fill the checklist: - in the line above the table, replace the api-name, api-version and the rx.y by their actual values for the current API version and release. - in the Status column, put "Y" (yes) if the release asset is available or fulfilled in the current release, a "N" (no) or a "tbd". Example use of "tbd" is in case an alpha or release-candidate API version does not yet provide all mandatory assets for the release.