Skip to content

Latest commit

 

History

History
186 lines (114 loc) · 9.32 KB

CHANGELOG.md

File metadata and controls

186 lines (114 loc) · 9.32 KB
Raw

Changelog Number Verification API

Table of contents

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.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.

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.

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

r1.1

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.

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: 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 #3
  • Adding API documentation by @monamok in #6
  • Initial content for Number Verify by @DT-DawidWroblewski in #2
  • New specific 403 token error and guidelines alignment by @monamok in #19
  • adding puml by @DT-DawidWroblewski in #24
  • guidelines alignment errors and camel case by @monamok in #30
  • Change 'sub' cardinality + add attribute description by @bigludo7 in #32
  • Embed documentation in API Spec by @monamok in #38

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