From c756a22477b643134cd497968eb3f3be88c5e4c8 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 27 Aug 2025 14:20:24 +0200 Subject: [PATCH 1/9] Update number-verification.yaml --- code/API_definitions/number-verification.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/code/API_definitions/number-verification.yaml b/code/API_definitions/number-verification.yaml index 94b40f8..3aed963 100644 --- a/code/API_definitions/number-verification.yaml +++ b/code/API_definitions/number-verification.yaml @@ -70,7 +70,7 @@ info: As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - version: wip + version: 2.1.0 x-camara-commonalities: 0.6 license: name: Apache 2.0 @@ -79,7 +79,7 @@ externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/NumberVerification servers: - - url: '{apiRoot}/number-verification/vwip' + - url: '{apiRoot}/number-verification/v2' variables: apiRoot: default: http://localhost:9091 @@ -227,15 +227,15 @@ components: - code - message properties: + message: + type: string + description: A human-readable description of what the event represents status: type: integer description: HTTP response status code code: type: string - description: Code given to this error - message: - type: string - description: Detailed error description + description: A human-readable code to describe the error responses: Generic400: description: Problem with the client request From 213624df5829cfdfb38f2e9228346d81cb323ef0 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 27 Aug 2025 14:21:00 +0200 Subject: [PATCH 2/9] Update number-verification-phoneNumberShare.feature --- .../number-verification-phoneNumberShare.feature | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/number-verification-phoneNumberShare.feature b/code/Test_definitions/number-verification-phoneNumberShare.feature index 4f5eb02..471f495 100644 --- a/code/Test_definitions/number-verification-phoneNumberShare.feature +++ b/code/Test_definitions/number-verification-phoneNumberShare.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Number Verification API, v2.1.0-rc.1 - Operation phoneNumberShare +Feature: CAMARA Number Verification API, v2.1.0 - Operation phoneNumberShare # Input to be provided by the implementation to the tester # @@ -9,7 +9,7 @@ Feature: CAMARA Number Verification API, v2.1.0-rc.1 - Operation phoneNumberShar # * a valid testing phone number supported by the service Background: Common phoneNumberShare setup - Given the resource "/number-verification/v2rc1" as base url + Given the resource "/number-verification/v2" 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" complies with the schema at "#/components/schemas/XCorrelator" From 29fdd4a813b26761a0167496395ada1d648d397e Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 27 Aug 2025 14:21:19 +0200 Subject: [PATCH 3/9] Update number-verification-phoneNumberVerify.feature --- .../number-verification-phoneNumberVerify.feature | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/Test_definitions/number-verification-phoneNumberVerify.feature b/code/Test_definitions/number-verification-phoneNumberVerify.feature index 0891ff1..83212c5 100644 --- a/code/Test_definitions/number-verification-phoneNumberVerify.feature +++ b/code/Test_definitions/number-verification-phoneNumberVerify.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Number Verification API, v2.1.0-rc.1 - Operation phoneNumberVerify +Feature: CAMARA Number Verification API, v2.1.0 - Operation phoneNumberVerify # Input to be provided by the implementation to the tester # @@ -10,7 +10,7 @@ Feature: CAMARA Number Verification API, v2.1.0-rc.1 - Operation phoneNumberVeri # * a valid testing hashed phone number supported by the service Background: Common phoneNumberVerify setup - Given the resource "/number-verification/v2rc1" as base url + Given the resource "/number-verification/v2" 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" complies with the schema at "#/components/schemas/XCorrelator" From 7fa0ae2589abc4866088813e13fe5b3799e37396 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 27 Aug 2025 14:25:13 +0200 Subject: [PATCH 4/9] Update number-verification-API-Readiness-Checklist.md --- .../number-verification-API-Readiness-Checklist.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/number-verification-API-Readiness-Checklist.md b/documentation/API_documentation/number-verification-API-Readiness-Checklist.md index 1486e4a..2e17cea 100644 --- a/documentation/API_documentation/number-verification-API-Readiness-Checklist.md +++ b/documentation/API_documentation/number-verification-API-Readiness-Checklist.md @@ -1,18 +1,18 @@ # API Readiness Checklist -Checklist for number-verification v2.1.0-rc.1 in release r3.1 +Checklist for number-verification v2.1.0 in release r3.2 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| | 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 | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | | 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-phoneNumberShare.feature) [verify](/code/Test_definitions/number-verification-phoneNumberVerify.feature) | | 8 | Enhanced API test cases & documentation | O | O | O | M | Y | [get](/code/Test_definitions/number-verification-phoneNumberShare.feature) [verify](/code/Test_definitions/number-verification-phoneNumberVerify.feature) | -| 9 | Test result statement | O | O | O | M | N | | +| 9 | Test result statement | O | O | O | M | N | See issue[#216](https://github.com/camaraproject/NumberVerification/issues/216) | | 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) | @@ -29,3 +29,4 @@ Note: the checklists of a public API version and of its preceding release-candid The documentation for the content of the checklist is here: see API Readiness Checklist section in the [API Release Process](https://lf-camaraproject.atlassian.net/wiki/x/jine). + From 20891752aa70bbf65bdd127de2398e849545bd71 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 27 Aug 2025 14:27:40 +0200 Subject: [PATCH 5/9] Update README.md --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1ab7862..4a36125 100644 --- a/README.md +++ b/README.md @@ -27,17 +27,11 @@ Incubating API Repository to evolve and maintain the definitions and documentati * 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**: The pre-release r3.1 with version 2.1.0-rc.1 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r3.1) - - 2.1.0-rc.1 Number Verification definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r3.1/code/API_definitions/number-verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.1/code/API_definitions/number-verification.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.1/code/API_definitions/number-verification.yaml) - -* The latest public release r2.4 with version 2.0.0 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r2.4) - - 2.0.0 Number Verification definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r2.4/code/API_definitions/number-verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r2.4/code/API_definitions/number-verification.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r2.4/code/API_definitions/number-verification.yaml) +* **NEW**: The latest public release r3.2 with version 2.1.0 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r3.2) + - 2.1.0 Number Verification definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.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 0fe7c62990855f9e2c9e92792d9b2d14d4a5f5c4 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 27 Aug 2025 14:40:29 +0200 Subject: [PATCH 6/9] Update CHANGELOG.md --- CHANGELOG.md | 62 +++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 52 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4c65a23..f4347de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,15 +3,16 @@ ## Table of contents -- **[r3.1](#r31) Fall25** -- **[r2.4](#r24) Spring25** +- [r3.2](#r32) **Fall25** +- [r3.1](#r31) +- [r2.4](#r24) **Spring25** - ~~[r2.3](#r23)~~ -- **[r2.2](#r22)** -- **[r2.1](#r21)** -- **[r1.3](#r13) Fall24** -- **[r1.2](#r12)** -- **[r1.1](#r11)** -- **[v0.3.1](#v031)** +- [r2.2](#r22) +- [r2.1](#r21) +- [r1.3](#r13) **Fall24** +- [r1.2](#r12) +- [r1.1](#r11) +- [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.** @@ -23,9 +24,50 @@ The below sections record the changes for each API version in each release as fo * for subsequent release-candidate(s), only the delta to the previous release-candidate * for a public release, the consolidated changes since the previous public release +# r3.2 + +This **public candidate** contains the definition and documentation of +* number-verification 2.1.0 + +The API definition(s) are based on +* Commonalities v0.6.0 +* Identity and Consent Management v0.4.0 + +## number-verification 2.1.0 + +**number-verification 2.1.0 is the public release for v2.1.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/r3.2/code/API_definitions/number-verification.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml) + +### Added + +- Add pattern validation for hashedPhoneNumber by @ravindrapalaskar17 in https://github.com/camaraproject/NumberVerification/pull/188 +- Documented Error Responses info.description section by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/199 +- Include documentation to use with JWT-bearer auth flow by @fernandopradocabrillo in https://github.com/camaraproject/NumberVerification/pull/206 + +### Changed + +- Update x-correlator format by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/200 +- Update test plan by @fernandopradocabrilo in https://github.com/camaraproject/NumberVerification/pull/204 +- Update ErrorInfo attribute description by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/217 + +### Removed + +- Remove AUTHENTICATION_REQUIRED error by @fernandopradocabrillo in https://github.com/camaraproject/NumberVerification/pull/206 +- Remove sequence diagram image in the yaml and instead refer to ICM by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/213 + +## New Contributors +* @ravindrapalaskar17 made their first contribution in https://github.com/camaraproject/NumberVerification/pull/188 + +**Full Changelog**: https://github.com/camaraproject/NumberVerification/compare/r2.4...r3.2 + + # r3.1 -This **public release** contains the definition and documentation of +This **release candidate** contains the definition and documentation of * number-verification 2.1.0-rc.1 The API definition(s) are based on @@ -34,7 +76,7 @@ The API definition(s) are based on ## number-verification 2.1.0-rc.1 -**number-verification 2.1.0-rc.1 is the first pre-release for v2.0.0-rc.1 of the NumberVerification API.** +**number-verification 2.1.0-rc.1 is the first pre-release for v2.1.0-rc.1 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/r3.1/code/API_definitions/number-verification.yaml&nocors) From df3f7a58ff4282a9c6423a1b415762cdcf70b62e Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 10 Sep 2025 15:10:34 +0200 Subject: [PATCH 7/9] Update CHANGELOG.md Co-authored-by: Kevin Smith --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f4347de..f5b76e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,7 +26,7 @@ The below sections record the changes for each API version in each release as fo # r3.2 -This **public candidate** contains the definition and documentation of +This **public release** contains the definition and documentation of * number-verification 2.1.0 The API definition(s) are based on From ef2d6f356817de8d01a572ab13488ff9a5167efb Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Wed, 10 Sep 2025 15:10:51 +0200 Subject: [PATCH 8/9] Update README.md Co-authored-by: Kevin Smith --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4a36125..86c0ab7 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Incubating API Repository to evolve and maintain the definitions and documentati * 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**: The latest public release r3.2 with version 2.1.0 of the API number-verification is available [here](https://github.com/camaraproject/NumberVerification/tree/r3.2) +* **NEW**: The latest public release r3.2 with version 2.1.0 of the API number-verification is available [here]( https://github.com/camaraproject/NumberVerification/releases/tag/r3.2) - 2.1.0 Number Verification definition **with inline documentation**: - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml) - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors) From e4ceed1128025ef2684fba17f95cc9c407675c2c Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 12 Sep 2025 10:08:34 +0200 Subject: [PATCH 9/9] fix ErrorInfo properties sorting --- code/API_definitions/number-verification.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/code/API_definitions/number-verification.yaml b/code/API_definitions/number-verification.yaml index 3aed963..1a6358a 100644 --- a/code/API_definitions/number-verification.yaml +++ b/code/API_definitions/number-verification.yaml @@ -227,15 +227,15 @@ components: - code - message properties: - message: - type: string - description: A human-readable description of what the event represents status: type: integer description: HTTP response status code code: type: string description: A human-readable code to describe the error + message: + type: string + description: A human-readable description of what the event represents responses: Generic400: description: Problem with the client request