From 183f0e39570cd0a1ff6ffb91699b644a90e33f21 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 18 Jul 2024 10:52:08 +0200 Subject: [PATCH 01/23] Update CHANGELOG.md --- CHANGELOG.md | 91 ++++++++++++++++++++++++++++++++-------------------- 1 file changed, 56 insertions(+), 35 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6b0b804..8072b89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,50 +1,71 @@ -# Changelog +# Changelog Number Verification API -## v0.4.0-wip [Work in Progress] -## Please note: +## Table of contents -- This is *work-in-progress* version, it should be considered as a draft -- There are bug fixes to be expected and incompatible changes in upcoming versions -- The release is suitable for implementors, but it is not recommended to use the API with customers in productive environments -- Version numbers before v0.4.0-wip were used during the development of this version but not released +- **[r1.1](#r11)** + + +**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.1 - rc + +## Release Notes + +This release contains the definition and documentation of +* Number Verification API 1.0.0-rc.1 + + + +The API definition(s) are based on +* Commonalities v0.4.0 +* Identity and Consent Management v0.2.0 + + +## Number Verification v1.0.0-rc.1 + + +**number-verification 1.0.0-rc.1** is the first release-candidate version for the v1.0.0 of the number verification API. + +- API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml) + - +**number-verification 1.0.0-rc.1 is the first stable version for CAMARA Number Verification API** + +This version contains significant changes compared to v0.3.1, and it is not backward compatible. ### Added -- Merge pull request #58 from fernandopradocabrillo/update-documentation-and-remove-deprecated-files -- include documentation inside yaml file, remove deprecated files and fix image link -- Merge pull request #57 from fernandopradocabrillo/update-tef-codeowners -- update codeowners from Telefónica -- Merge pull request #56 from camaraproject/bigludo7-patch-1 -- Merge pull request #58 from fernandopradocabrillo/update-documentation-and-remove-deprecated-files -- include documentation inside yaml file, remove deprecated files and fix image link -- Merge pull request #57 from fernandopradocabrillo/update-tef-codeowners -- update codeowners from Telefónica -- Merge pull request #56 from camaraproject/bigludo7-patch-1 -- Update number_verification.yaml -- Merge pull request #53 from DT-DawidWroblewski/main -- update to yaml -- Merge branch 'main' of https://github.com/DT-DawidWroblewski/NumberVerification -- adding fixes to PR -- Merge pull request #52 from jlurien/chore/replace-polymorphism-requestBody -- Replace polymorphism in requestBody of POST /verify -- Update documentation/API_documentation/README.MD -- Merge pull request #50 from monamok/chore/update_documentation -- cleaning repo -- Relevant definition section added -- Merge pull request #43 from monamok/chore/phone_number_description_alignment -- error code copy/pase typo removed -- updating uml url -- phoneNumber descriptions aligned to the other APIs +* User Story in documentation/API_documentation directory by @bigludo7 [PR118](https://github.com/camaraproject/NumberVerification/pull/118) +* Test Definition in Test_Definitions directory [To be done] ### Changed -* N/A +* Aligned with CAMARA design guidelines & Identity Consent management +* 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 -* N/A +* Replaced OAuth2 auth code flow by OIDC auth code flow by @AxelNennker [PR109](https://github.com/camaraproject/NumberVerification/pull/109) ### Removed -* N/A \ No newline at end of file +* n/a + +## New Contributors + +- @AxelNennker made their first contribution in clarifying use of 'user' and 'subscriber' wording by @AxelNennker [PR102](https://github.com/camaraproject/NumberVerification/pull/102) +- @rartych made their first contribution in GitHub workflows [#108](https://github.com/camaraproject/NumberVerification/pull/108) +- @fernandopradocabrillo made their first contribution by updating Authorization and authentication part accordingly to ICM [PR88](https://github.com/camaraproject/NumberVerification/issues/88) +- @maxl2287 made their first contribution by adding a pattern for PhoneNumber in /verify [PR68](https://github.com/camaraproject/NumberVerification/issues/76) +- @bigludo7 made their first contribution by making change following megalinter integration [PR103](https://github.com/camaraproject/NumberVerification/pull/103) + + From 3a921a8daf1b03d78c38653866c4159dedb9fb94 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 18 Jul 2024 10:53:37 +0200 Subject: [PATCH 02/23] Update README.md --- README.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9227fc1..681bb12 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,22 @@ Repository to describe, develop, document and test the NumberVerification API fa ## Meetings -* Meetings are held virtually in Zoom -* Current schedule & meeting links: [Meetings information](documentation/MeetingMinutes/README.MD) +* Current schedule, registration, & meeting links are available on the confluence page: [Meetings information](https://wiki.camaraproject.org/display/CAM/NumberVerification) + -## Results -* Sub Project is in progress ## 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 available release and version of CAMARA NumberVerification API is 0.3.1. This is the first alpha version of the API.** There are bug fixes to be expected and incompatible changes in upcoming releases. It is suitable for implementors, but it is not recommended to use the API with customers in productive environments. -* Release 0.3.1 of the API is available within the [release-0.3.1 branch](https://github.com/camaraproject/NumberVerification/tree/release-0.3.1): +* **The latest available release and version of CAMARA OTPValidaton API is 1.0.0-rc.1 This is the first stable version candidate of the API**. It is suitable for implementors and could be use with customers in productive environments. +* Release 1.0.0 of the API is available within the [release-1.0.0 branch](https://github.com/camaraproject/NumberVerification/tree/release-1.0.0): + - API definition **with inline documentation**: + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml&nocors) + - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/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): - 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) @@ -41,3 +46,8 @@ Repository to describe, develop, document and test the NumberVerification API fa * To subscribe / unsubscribe to the mailing list of this Sub Project and thus be / resign as Contributor please visit . * A message to all Contributors of this Sub Project can be sent using . + + +## 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) From 5340d1660d247255607beb992e12998161107937 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 18 Jul 2024 10:54:32 +0200 Subject: [PATCH 03/23] Update number_verification.yaml version --- 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 61d25e6..e2097c4 100644 --- a/code/API_definitions/number_verification.yaml +++ b/code/API_definitions/number_verification.yaml @@ -48,7 +48,7 @@ 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-rc.1 termsOfService: http://example.com/terms/ contact: name: API Support From 730fe90c7bdf8e1ad711baa54ba15e0c15ff337d Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 18 Jul 2024 18:38:43 +0200 Subject: [PATCH 04/23] Add readiness checklist --- .../NumberVerification-Readiness-Checklist.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 documentation/API_documentation/NumberVerification-Readiness-Checklist.md diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md new file mode 100644 index 0000000..47249c9 --- /dev/null +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -0,0 +1,25 @@ +# API Readiness Checklist + +Checklist for number_verification in version b1.0.0-rc1.1 + +| Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | +|----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| +| 1 | API definition | M | M | M | M | Y | [link](https://github.com/camaraproject/NumberVerification/blob/main/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](https://github.com/camaraproject/NumberVerification/blob/main/code/API_definitions/number_verification.yaml) | +| 6 | User stories | O | O | O | M | N | [PR118](https://github.com/camaraproject/NumberVerification/pull/118) | +| 7 | Basic API test cases & documentation | O | M | M | M | N | link | +| 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | +| 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 | [PR121](https://github.com/camaraproject/NumberVerification/pull/121) | +| 12 | Previous public-release was certified | O | O | O | M | Y | | + + + + +Note: It is normal that the checklists of the (final) release-candidate and its subsequent public-release are the same, while additional release assets are required for a subsequent stable public-release. + +The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist) \ No newline at end of file From f8c274c028f3a1cc77692597e84b24cec8510817 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 19 Jul 2024 13:32:03 +0200 Subject: [PATCH 05/23] Update number_verification.yaml --- code/API_definitions/number_verification.yaml | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/code/API_definitions/number_verification.yaml b/code/API_definitions/number_verification.yaml index e2097c4..0a881b1 100644 --- a/code/API_definitions/number_verification.yaml +++ b/code/API_definitions/number_verification.yaml @@ -49,20 +49,16 @@ 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: 1.0.0-rc.1 - termsOfService: http://example.com/terms/ - contact: - name: API Support - url: http://www.example.com/support - email: support@example.com + 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/v0' + - url: '{apiRoot}/number-verification/v1rc1' variables: apiRoot: default: http://localhost:9091 - description: API root + description: API root, defined by the service provider, e.g. `api.example.com` or `api.example.com/somepath tags: - name: Phone number verify description: API operation to verify a phone number received as input. It can be received either in plain text or hashed format. From d87c602db3d5511ce04d98e2f44c494ae0e0fd7f Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 19 Jul 2024 13:40:04 +0200 Subject: [PATCH 06/23] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 681bb12..ef18447 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,12 @@ 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 available release and version of CAMARA OTPValidaton API is 1.0.0-rc.1 This is the first stable version candidate of the API**. It is suitable for implementors and could be use with customers in productive environments. -* Release 1.0.0 of the API is available within the [release-1.0.0 branch](https://github.com/camaraproject/NumberVerification/tree/release-1.0.0): +* **The latest available release and version of CAMARA Number Verification API is 1.0.0-rc.1 This is the first stable version candidate of the API**. It is suitable for implementors and could be use with customers in productive environments. +* 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/release-1.0.0/code/API_definitions/number_verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml) + - 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/blob/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/blob/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): From 3e93083143507a5dee65044b27ccbb78b68a76c5 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Fri, 19 Jul 2024 13:41:59 +0200 Subject: [PATCH 07/23] Update CHANGELOG.md --- CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8072b89..71691ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,10 +30,10 @@ The API definition(s) are based on **number-verification 1.0.0-rc.1** is the first release-candidate version for the v1.0.0 of the number verification API. - API definition **with inline documentation**: - - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml) - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml&nocors) - - [View it on Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/blob/release-1.0.0/code/API_definitions/number_verification.yaml) - - + - 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/blob/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/blob/r1.1/code/API_definitions/number_verification.yaml) + **number-verification 1.0.0-rc.1 is the first stable version for CAMARA Number Verification API** This version contains significant changes compared to v0.3.1, and it is not backward compatible. From 1fbba6e2df403936f4b486ae128cd11f4bb0c2bc Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:29:54 +0200 Subject: [PATCH 08/23] Update README.md Co-authored-by: Herbert Damker --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ef18447..fcbc5e3 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ 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 available release and version of CAMARA Number Verification API is 1.0.0-rc.1 This is the first stable version candidate of the API**. It is suitable for implementors and could be use with customers in productive environments. +* **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) From 5a9bad894573acb0af791bb7944338daf2ff829d Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:30:10 +0200 Subject: [PATCH 09/23] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../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 47249c9..a98b8f9 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -4,7 +4,8 @@ Checklist for number_verification in version b1.0.0-rc1.1 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| -| 1 | API definition | M | M | M | M | Y | [link](https://github.com/camaraproject/NumberVerification/blob/main/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 | | From d30f878fda232c3482261045a6454a922d97fff0 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:31:02 +0200 Subject: [PATCH 10/23] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../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 a98b8f9..85b7d0c 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -9,7 +9,8 @@ Checklist for number_verification in version b1.0.0-rc1.1 | 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](https://github.com/camaraproject/NumberVerification/blob/main/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 | N | [PR118](https://github.com/camaraproject/NumberVerification/pull/118) | | 7 | Basic API test cases & documentation | O | M | M | M | N | link | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | From 8889b4bf3fd5e4c4b0ebff973f2c494238532d8f Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:31:07 +0200 Subject: [PATCH 11/23] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../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 85b7d0c..9ae2d8c 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -16,7 +16,8 @@ Checklist for number_verification in version b1.0.0-rc1.1 | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | | 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 | [PR121](https://github.com/camaraproject/NumberVerification/pull/121) | +| 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) | + | 12 | Previous public-release was certified | O | O | O | M | Y | | From b82166c84bbccb17dcb5d7e0970d70cb1bd5c088 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:31:14 +0200 Subject: [PATCH 12/23] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 71691ca..a07d061 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ ## Table of contents - **[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.** From b3e966b7260ba9b45445aac79bee9bf74831bf5a Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:31:21 +0200 Subject: [PATCH 13/23] Update CHANGELOG.md Co-authored-by: Herbert Damker --- CHANGELOG.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a07d061..3edb86d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -69,4 +69,20 @@ This version contains significant changes compared to v0.3.1, and it is not back - @maxl2287 made their first contribution by adding a pattern for PhoneNumber in /verify [PR68](https://github.com/camaraproject/NumberVerification/issues/76) - @bigludo7 made their first contribution by making change following megalinter integration [PR103](https://github.com/camaraproject/NumberVerification/pull/103) +**Full Changelog**: https://github.com/camaraproject/NumberVerification/compare/v0.3.1...r1.1 +## v0.3.1 + +Initital release of Camara Number Verification API + +## What's Changed +* Telefonica Proposal by @monamok in https://github.com/camaraproject/NumberVerification/pull/3 +* Adding API documentation by @monamok in https://github.com/camaraproject/NumberVerification/pull/6 +* Initial content for Number Verify by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/2 +* New specific 403 token error and guidelines alignment by @monamok in https://github.com/camaraproject/NumberVerification/pull/19 +* adding puml by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/24 +* guidelines alignment errors and camel case by @monamok in https://github.com/camaraproject/NumberVerification/pull/30 +* Change 'sub' cardinality + add attribute description by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/32 +* Embed documentation in API Spec by @monamok in https://github.com/camaraproject/NumberVerification/pull/38 + +**Full Changelog**: https://github.com/camaraproject/NumberVerification/commits/v0.3.1 From c253ee33c0f55759bd5c4b605c7daf9cffe003e7 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:52:32 +0200 Subject: [PATCH 14/23] Update NumberVerification-Readiness-Checklist.md --- .../NumberVerification-Readiness-Checklist.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index 9ae2d8c..294b4b3 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -5,19 +5,16 @@ Checklist for number_verification in version b1.0.0-rc1.1 | 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) | - | 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) | - -| 6 | User stories | O | O | O | M | N | [PR118](https://github.com/camaraproject/NumberVerification/pull/118) | +| 6 | User stories | O | O | O | M | N | [link](documentation/API_documentation/) | | 7 | Basic API test cases & documentation | O | M | M | M | N | link | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | | 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 | | @@ -25,4 +22,4 @@ Checklist for number_verification in version b1.0.0-rc1.1 Note: It is normal that the checklists of the (final) release-candidate and its subsequent public-release are the same, while additional release assets are required for a subsequent stable public-release. -The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist) \ No newline at end of file +The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist) From cbfaca629b6598252f339c94d678029062dbc876 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 14:58:17 +0200 Subject: [PATCH 15/23] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md Co-authored-by: Herbert Damker --- .../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 294b4b3..c1e6e2f 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 in version b1.0.0-rc1.1 +Checklist for number_verification 1.0.0-rc.1 in release r1.1 | Nr | API release assets | alpha | release-candidate | public-release
initial | public-release
stable | Status | Comments | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:----:| From 4ca59675aa6c2ee191ea47233e2e5a4c4099abb0 Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 15:10:33 +0200 Subject: [PATCH 16/23] Update CHANGELOG.md --- CHANGELOG.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3edb86d..66b1ae1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -79,10 +79,18 @@ Initital release of Camara Number Verification API * Telefonica Proposal by @monamok in https://github.com/camaraproject/NumberVerification/pull/3 * Adding API documentation by @monamok in https://github.com/camaraproject/NumberVerification/pull/6 * Initial content for Number Verify by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/2 +* main readme update by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/12 +* reshaping the content (+readme.md update) by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/13 +* fixing links by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/14 +* fixing links by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/15 * New specific 403 token error and guidelines alignment by @monamok in https://github.com/camaraproject/NumberVerification/pull/19 +* repo fine tunining by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/23 +* Repo fine tuning recovery by @monamok in https://github.com/camaraproject/NumberVerification/pull/22 * adding puml by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/24 * guidelines alignment errors and camel case by @monamok in https://github.com/camaraproject/NumberVerification/pull/30 +* updating content insde readme.md by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/34 * Change 'sub' cardinality + add attribute description by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/32 +* Adding PR and Issues commonalities templates by @monamok in https://github.com/camaraproject/NumberVerification/pull/40 * Embed documentation in API Spec by @monamok in https://github.com/camaraproject/NumberVerification/pull/38 **Full Changelog**: https://github.com/camaraproject/NumberVerification/commits/v0.3.1 From 8e7ddc3766eb29112e6bcc17120b6bfa677d1c4c Mon Sep 17 00:00:00 2001 From: Ludovic Robert <30499179+bigludo7@users.noreply.github.com> Date: Thu, 25 Jul 2024 15:12:28 +0200 Subject: [PATCH 17/23] Update CHANGELOG.md --- CHANGELOG.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 66b1ae1..3edb86d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -79,18 +79,10 @@ Initital release of Camara Number Verification API * Telefonica Proposal by @monamok in https://github.com/camaraproject/NumberVerification/pull/3 * Adding API documentation by @monamok in https://github.com/camaraproject/NumberVerification/pull/6 * Initial content for Number Verify by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/2 -* main readme update by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/12 -* reshaping the content (+readme.md update) by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/13 -* fixing links by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/14 -* fixing links by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/15 * New specific 403 token error and guidelines alignment by @monamok in https://github.com/camaraproject/NumberVerification/pull/19 -* repo fine tunining by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/23 -* Repo fine tuning recovery by @monamok in https://github.com/camaraproject/NumberVerification/pull/22 * adding puml by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/24 * guidelines alignment errors and camel case by @monamok in https://github.com/camaraproject/NumberVerification/pull/30 -* updating content insde readme.md by @DT-DawidWroblewski in https://github.com/camaraproject/NumberVerification/pull/34 * Change 'sub' cardinality + add attribute description by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/32 -* Adding PR and Issues commonalities templates by @monamok in https://github.com/camaraproject/NumberVerification/pull/40 * Embed documentation in API Spec by @monamok in https://github.com/camaraproject/NumberVerification/pull/38 **Full Changelog**: https://github.com/camaraproject/NumberVerification/commits/v0.3.1 From f2aa2d81cb9f37ad14a81673e8097293e05b6d08 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 8 Aug 2024 15:48:30 +0200 Subject: [PATCH 18/23] Update documentation/API_documentation/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 c1e6e2f..94625e8 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -9,7 +9,7 @@ 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 | N | [link](documentation/API_documentation/) | +| 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 | N | link | | 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | | 9 | Test result statement | O | O | O | M | N | link | From c6a63a2bff4e6e31c4e4868dadd291eb874d02ef Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 8 Aug 2024 15:48:36 +0200 Subject: [PATCH 19/23] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md --- .../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 94625e8..0de7ef2 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-rc.1 in release r1.1 | 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 | N | link | -| 8 | Enhanced API test cases & documentation | O | O | O | M | N | link | +| 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 | 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) | From a0bc785470777510a0a0feb2e99afe922585f76f Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Thu, 8 Aug 2024 15:48:44 +0200 Subject: [PATCH 20/23] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md --- .../NumberVerification-Readiness-Checklist.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md index 0de7ef2..07b4080 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -17,9 +17,11 @@ Checklist for number_verification 1.0.0-rc.1 in release r1.1 | 11 | Change log updated | M | M | M | M | N | [link](/CHANGELOG.md) | | 12 | Previous public-release was certified | O | O | O | M | Y | | +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. +- in the Comments column, provide the link to the asset once available, and any other relevant comments. +Note: the checklists of a public API version and of its preceding release-candidate API version can be the same. - -Note: It is normal that the checklists of the (final) release-candidate and its subsequent public-release are the same, while additional release assets are required for a subsequent stable public-release. - -The documentation for the content of the checklist is here: [API Readiness Checklist documentation](https://wiki.camaraproject.org/x/AgAVAQ#APIReleaseProcess-APIreadinesschecklist) +The documentation for the content of the checklist is here: [API Readiness Checklist](https://wiki.camaraproject.org/display/CAM/API+Release+Process#APIReleaseProcess-APIreadinesschecklist). From cd0b7298d31d65267893d74c5a861f0fa4540e56 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Fri, 16 Aug 2024 14:16:44 +0200 Subject: [PATCH 21/23] Update README.md Corrected raw content links --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fcbc5e3..bc5754e 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ Repository to describe, develop, document and test the NumberVerification API fa * 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/blob/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/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): From 4a9630b645f49e3aab5df8f6a2a86fe6b532e1d0 Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Fri, 16 Aug 2024 14:22:58 +0200 Subject: [PATCH 22/23] Update documentation/API_documentation/NumberVerification-Readiness-Checklist.md set "Test result statement" from "N" to "tbd". --- .../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 07b4080..d00b0b8 100644 --- a/documentation/API_documentation/NumberVerification-Readiness-Checklist.md +++ b/documentation/API_documentation/NumberVerification-Readiness-Checklist.md @@ -12,7 +12,8 @@ Checklist for number_verification 1.0.0-rc.1 in release r1.1 | 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 | N | link | +| 9 | Test result statement | O | O | O | M | tbd | 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 | | From 1de93ff1cd27992ddcea99e6f04beb7c015b10cd Mon Sep 17 00:00:00 2001 From: Herbert Damker Date: Fri, 16 Aug 2024 14:26:21 +0200 Subject: [PATCH 23/23] Update CHANGELOG.md --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3edb86d..14e9e60 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -32,8 +32,8 @@ The API definition(s) are based on - 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/blob/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/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) **number-verification 1.0.0-rc.1 is the first stable version for CAMARA Number Verification API**