r3.2

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

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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Add pattern validation for hashedPhoneNumber by @ravindrapalaskar17 in #188
• Documented Error Responses info.description section by @bigludo7 in #199
• Include documentation to use with JWT-bearer auth flow by @fernandopradocabrillo in #206

Changed

• Update x-correlator format by @bigludo7 in #200
• Update test plan by @fernandopradocabrilo in #204
• Update ErrorInfo attribute description by @bigludo7 in #217

Removed

• Remove AUTHENTICATION_REQUIRED error by @fernandopradocabrillo in #206
• Remove sequence diagram image in the yaml and instead refer to ICM by @bigludo7 in #213

New Contributors

• @ravindrapalaskar17 made their first contribution in #188

Full Changelog: r2.4...r3.2

r3.1

This pre-release 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

number-verification 2.1.0-rc.1 is the first pre-release for v2.0.0-rc.1 of the NumberVerification API.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

• Add pattern validation for hashedPhoneNumber by @ravindrapalaskar17 in #188
• Documented Error Responses info.description section by @bigludo7 in #199
• Include documentation to use with JWT-bearer auth flow by @fernandopradocabrillo in #206

Changed

• Update x-correlator format by @bigludo7 in #200
• Update test plan by @fernandopradocabrilo in #204

Removed

• Remove AUTHENTICATION_REQUIRED error by @fernandopradocabrillo in #206

New Contributors

• @ravindrapalaskar17 made their first contribution in #188

Full Changelog: r2.4...r3.1

r2.4

Release Notes

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

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:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Changes included in v2.0.0 compared to v1.0.0

Changed

• Align error list & model with comm 0.5 by @bigludo7 in #161
• Add a pattern for x-correlator allowing zero-length string by @bigludo7 in #164
• servers.url format aligned with current guidelines ('{apiRoot}/number-verification/v1rc2') by @hdamker in #169
• Link into main branch replaced with link into release branch by @hdamker in #169
• NumberVerification over WiFi by @AxelNennker in #174

Removed

• Remove 403 INVALID_TOKEN_CONTEXT by @bigludo7 in #163

Full Changelog between v2.0.0 and v1.0.0: r1.3...r2.4

New Contributors

• @hdamker made their first contribution by servers.url format aligned with current guidelines ('{apiRoot}/number-verification/v1rc2')

r2.2

Release Notes

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

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 #168

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Changed

• servers.url format aligned with current guidelines ('{apiRoot}/number-verification/v1rc2') by @hdamker in #169
• Link into main branch replaced with link into release branch by @hdamker in #169

Full Changelog: r2.1...r2.2

r2.1

Release Notes

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

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:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Changed

• Align error list & model with comm 0.5 by @bigludo7 in #161
• Add a pattern for x-correlator allowing zero-length string by @bigludo7 in #164

Removed

• Remove 403 INVALID_TOKEN_CONTEXT by @bigludo7 in #163

Full Changelog: r1.3...r2.1

r1.3

Release Notes

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

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
  • View it on Swagger Editor
  • OpenAPI YAML spec file

Added

Changed

Fixed

• @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

Removed

New Contributors

• N/A

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 release of the first stable version of the NumberVerification API.

• API definition with inline documentation:
  • View it on ReDoc
  • View it on Swagger Editor
  • OpenAPI YAML spec file

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

• User Story in documentation/API_documentation directory by @bigludo7 PR118
• Test Definition in Test_Definitions directory by @AxelNennker PR124

Changed

• 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

Fixed

• Replaced OAuth2 auth code flow by OIDC auth code flow by @AxelNennker PR109

Removed

• Removed documentation (replaced by doc in the yaml) by @AxelNennker PR137

New Contributors

• N/A

Full changelog here

r1.1

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
  • View it on ReDoc
  • View it on Swagger Editor

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

• User Story in documentation/API_documentation directory by @bigludo7 PR118
• Test Definition in Test_Definitions directory [To be done]

Changed

• 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

Fixed

• Replaced OAuth2 auth code flow by OIDC auth code flow by @AxelNennker PR109

Removed

• n/a

New Contributors

• @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: v0.3.1...r1.1

v0.3.1

Initital release of Camara Number Verification API

What's Changed

• Telefonica Proposal by @monamok in #3
• Adding API documentation by @monamok in #6
• Initial content for Number Verify by @DT-DawidWroblewski in #2
• main readme update by @DT-DawidWroblewski in #12
• reshaping the content (+readme.md update) by @DT-DawidWroblewski in #13
• fixing links by @DT-DawidWroblewski in #14
• fixing links by @DT-DawidWroblewski in #15
• New specific 403 token error and guidelines alignment by @monamok in #19
• repo fine tunining by @DT-DawidWroblewski in #23
• Repo fine tuning recovery by @monamok in #22
• adding puml by @DT-DawidWroblewski in #24
• guidelines alignment errors and camel case by @monamok in #30
• updating content insde readme.md by @DT-DawidWroblewski in #34
• Change 'sub' cardinality + add attribute description by @bigludo7 in #32
• Adding PR and Issues commonalities templates by @monamok in #40
• Embed documentation in API Spec by @monamok in #38

Full Changelog: https://github.com/camaraproject/NumberVerification/commits/v0.3.1