Starting with release automation, new release changelogs are maintained in the CHANGELOG/ directory with per-cycle files.
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.
The below sections record the changes for each API version in each release as follows:
- for an alpha release, the delta with respect to the previous release
- for the first release-candidate, all changes since the last public release
- 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
This public release 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 is the public release for v2.1.0 of the NumberVerification API.
- API definition with inline documentation:
- Add pattern validation for hashedPhoneNumber by @ravindrapalaskar17 in camaraproject#188
- Documented Error Responses info.description section by @bigludo7 in camaraproject#199
- Include documentation to use with JWT-bearer auth flow by @fernandopradocabrillo in camaraproject#206
- Update x-correlator format by @bigludo7 in camaraproject#200
- Update test plan by @fernandopradocabrilo in camaraproject#204
- Update ErrorInfo attribute description by @bigludo7 in camaraproject#217
- Remove AUTHENTICATION_REQUIRED error by @fernandopradocabrillo in camaraproject#206
- Remove sequence diagram image in the yaml and instead refer to ICM by @bigludo7 in camaraproject#213
- @ravindrapalaskar17 made their first contribution in camaraproject#188
Full Changelog: https://github.com/camaraproject/NumberVerification/compare/r2.4...r3.2
This release candidate contains the definition and documentation of
- number-verification 2.1.0-rc.1
The API definition(s) are based on
- Commonalities v0.6.0-rc.1
- Identity and Consent Management v0.4.0-rc.1
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:
- Add pattern validation for hashedPhoneNumber by @ravindrapalaskar17 in camaraproject#188
- Documented Error Responses info.description section by @bigludo7 in camaraproject#199
- Include documentation to use with JWT-bearer auth flow by @fernandopradocabrillo in camaraproject#206
- Update x-correlator format by @bigludo7 in camaraproject#200
- Update test plan by @fernandopradocabrilo in camaraproject#204
- Remove AUTHENTICATION_REQUIRED error by @fernandopradocabrillo in camaraproject#206
- @ravindrapalaskar17 made their first contribution in camaraproject#188
Full Changelog: https://github.com/camaraproject/NumberVerification/compare/r2.4...r3.1
This public release contains the definition and documentation of
- number-verification 2.0.0
The API definition(s) are based on
- Commonalities v0.5.0
- Identity and Consent Management v0.3.0
number-verification 2.0.0 is the public release for v2.0.0 of the NumberVerification API.
The NumberVerification API version has been upgraded from previous v1.0.0 to v2.0.0 even though the functionality updates included in this version do not contain any breaking change. However, the inclusion of a new supported authentication method (CIBA+TS.43 temporary token) to enable the use of the API over Wifi, justifies the generation of a new major version of the API.
- API definition with inline documentation:
Changes included in v2.0.0 compared to v1.0.0
- Align error list & model with comm 0.5 by @bigludo7 in camaraproject#161
- Add a pattern for x-correlator allowing zero-length string by @bigludo7 in camaraproject#164
- servers.url format aligned with current guidelines (
'{apiRoot}/number-verification/v1rc2') by @hdamker in camaraproject#169 - Link into main branch replaced with link into release branch by @hdamker in camaraproject#169
- NumberVerification over WiFi by @AxelNennker in camaraproject#174
- Remove 403 INVALID_TOKEN_CONTEXT by @bigludo7 in camaraproject#163
Full Changelog between v2.0.0 and v1.0.0: https://github.com/camaraproject/NumberVerification/compare/r1.3...r2.4
- @hdamker made their first contribution by servers.url format aligned with current guidelines (
'{apiRoot}/number-verification/v1rc2')
Release r2.3 has been revoked and removed in favor of the release r2.4
Following the recent approval of TS.43 temporary tokens usage in the ICM workgroup, it has been decided that this API will support them, enabling authentication over WiFi networks.
As a result, in release r2.4, both authentication methods are now available:
- AuthCode + network-based authentication
- CIBA + TS.43 temporary tokens
r2.4 is the official public release for Spring25 meta-release.
This pre-release release contains the definition and documentation of
- number-verification 1.1.0-rc.2
The API definition(s) are based on
- Commonalities v0.5.0-rc.1
- Identity and Consent Management v0.3.0-rc.1
number-verification 1.1.0-rc.2 is the second pre-release for v1.1.0 of the NumberVerification API.
Main purpose of the rc.2 version is to address camaraproject#168
- API definition with inline documentation:
- servers.url format aligned with current guidelines (
'{apiRoot}/number-verification/v1rc2') by @hdamker in camaraproject#169 - Link into main branch replaced with link into release branch by @hdamker in camaraproject#169
Full Changelog: https://github.com/camaraproject/NumberVerification/compare/r2.1...r2.2
This pre-release contains the definition and documentation of
- number-verification 1.1.0-rc.1
The API definition(s) are based on
- Commonalities v0.5.0-rc.1
- Identity and Consent Management v0.3.0-rc.1
number-verification 1.1.0-rc.1 is the first pre-release for v1.1.0 of the NumberVerification API.
- API definition with inline documentation:
- Align error list & model with comm 0.5 by @bigludo7 in camaraproject#161
- Add a pattern for x-correlator allowing zero-length string by @bigludo7 in camaraproject#164
- Remove 403 INVALID_TOKEN_CONTEXT by @bigludo7 in camaraproject#163
Full Changelog: https://github.com/camaraproject/NumberVerification/compare/r1.3...r2.1
This patch 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
Note: The API definition is unchanged compared to r1.2. The patch release r1.3 fixes only 4 test definition scenarios as listed below.
number-verification 1.0.0 is the release of the first stable version of the NumberVerification API.
- API definition with inline documentation:
- @NumberVerification_phone_number_share201_missing_scope: Changed code to PERMISSION_DENIED (previous was UNAUTHENTICATED) PR148
- @NumberVerification_phone_number_share202_expired_access_token: Changed code to UNAUTHENTICATED (previous was AUTHENTICATION_REQUIRED) PR148
- @NumberVerification_verify201_missing_scope: Changed code to PERMISSION_DENIED (previous was UNAUTHENTICATED) PR148
- @NumberVerification_verify202_expired_access_token: Changed code to UNAUTHENTICATED (previous was AUTHENTICATION_REQUIRED) PR148
- N/A
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 is the release of the first stable version of the NumberVerification API.
- API definition with inline documentation:
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
- User Story in documentation/API_documentation directory by @bigludo7 PR118
- Test Definition in Test_Definitions directory by @AxelNennker PR124
- Aligned with CAMARA design guidelines & Identity Consent management by @AxelNennker
- Make the '+' mandatory for the phone number by @fernandopradocabrillo PR90
- Cosmetic change following megalinter integration by @bigludo7 PR103
- Update Authorization and authentication part accordingly to ICM by @fernandopradocabrillo PR88
- Adding a pattern for PhoneNumber in /verify by @maxl2287 PR68
- Clarify use of 'user' and 'subscriber' wording by @AxelNennker PR102
- Clarify that the sequence diagram in the yaml documentation is an example by @bigludo7 PR139
- Replaced OAuth2 auth code flow by OIDC auth code flow by @AxelNennker PR109
- Removed documentation (replaced by doc in the yaml) by @AxelNennker PR137
- N/A
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 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:
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.
- User Story in documentation/API_documentation directory by @bigludo7 PR118
- Test Definition in Test_Definitions directory [To be done]
- Aligned with CAMARA design guidelines & Identity Consent management
- Make the '+' mandatory for the phone number by @fernandopradocabrillo PR90
- Cosmetic change following megalinter integration by @bigludo7 PR103
- Update Authorization and authentication part accordingly to ICM by @fernandopradocabrillo PR88
- Adding a pattern for PhoneNumber in /verify by @maxl2287 PR68
- Clarify use of 'user' and 'subscriber' wording by @AxelNennker PR102
- Replaced OAuth2 auth code flow by OIDC auth code flow by @AxelNennker PR109
- n/a
- @AxelNennker made their first contribution in clarifying use of 'user' and 'subscriber' wording by @AxelNennker PR102
- @rartych made their first contribution in GitHub workflows #108
- @fernandopradocabrillo made their first contribution by updating Authorization and authentication part accordingly to ICM PR88
- @maxl2287 made their first contribution by adding a pattern for PhoneNumber in /verify PR68
- @bigludo7 made their first contribution by making change following megalinter integration PR103
Full Changelog: https://github.com/camaraproject/NumberVerification/compare/v0.3.1...r1.1
Initital release of Camara Number Verification API
- Telefonica Proposal by @monamok in camaraproject#3
- Adding API documentation by @monamok in camaraproject#6
- Initial content for Number Verify by @DT-DawidWroblewski in camaraproject#2
- New specific 403 token error and guidelines alignment by @monamok in camaraproject#19
- adding puml by @DT-DawidWroblewski in camaraproject#24
- guidelines alignment errors and camel case by @monamok in camaraproject#30
- Change 'sub' cardinality + add attribute description by @bigludo7 in camaraproject#32
- Embed documentation in API Spec by @monamok in camaraproject#38
Full Changelog: https://github.com/camaraproject/NumberVerification/commits/v0.3.1