diff --git a/CHANGELOG/CHANGELOG-r4.md b/CHANGELOG/CHANGELOG-r4.md index 161d19c..107d50e 100644 --- a/CHANGELOG/CHANGELOG-r4.md +++ b/CHANGELOG/CHANGELOG-r4.md @@ -2,6 +2,7 @@ ## Table of Contents +- **[r4.2](#r42)** - [r4.1](#r41) @@ -14,6 +15,101 @@ 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 +# r4.2 + +## Release Notes + +This public release contains the definition and documentation of +* number-verification 2.1.1 + +The API definition(s) are based on +* Commonalities r4.4 (0.9.0) +* Identity and Consent Management r4.2 (0.5.0) + + +> **Working area — candidate changes (auto-removed on merge)** +> Copy relevant entries into the Breaking changes/Added/Changed/Fixed/Removed sections below. List breaking changes both in Breaking changes and in their normal change category. +> You may edit this list while triaging; it will be removed on merge. +> This working-area section is removed automatically when the PR is merged. + +
+Candidate changes (auto-generated from merged PRs) + +## What's Changed +* Chore: Reset version numbers to wip following meta-release by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/222 +* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/NumberVerification/pull/223 +* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/NumberVerification/pull/225 +* Access token security considerations for Number Verification API by @jpengar in https://github.com/camaraproject/NumberVerification/pull/226 +* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/NumberVerification/pull/229 +* Update release-plan.yaml by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/232 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/NumberVerification/pull/233 +* Set target release type to pre-release-alpha by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/234 +* fix validation rc Sync26 by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/235 +* Correct externalDocs.description wording in number-verification.yaml by @hdamker in https://github.com/camaraproject/NumberVerification/pull/240 +* Change release type and API status to 'rc' by @hdamker in https://github.com/camaraproject/NumberVerification/pull/243 +* Add companion whitepaper: Operator Token Acquisition for Number Verification on Android (TS.43/OpenID4VP) by @albertoramosmonagas in https://github.com/camaraproject/NumberVerification/pull/238 +* Update commonalities_release to version r4.4 by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/248 +* Sync common files from Commonalities r4.4 by @camara-release-automation[bot] in https://github.com/camaraproject/NumberVerification/pull/250 +* fix(number-verification): re-sync additional-error-responses description and bump commonalities to 0.9.0 by @hdamker in https://github.com/camaraproject/NumberVerification/pull/252 +* fix(number-verification): correct Gherkin test definition defects by @hdamker in https://github.com/camaraproject/NumberVerification/pull/255 +* Refactor DevicePhoneNumber reference in YAML by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/249 +* test(number-verification): add missing 400 scenario for phoneNumberShare by @hdamker in https://github.com/camaraproject/NumberVerification/pull/257 +* Align Error response to the Commonalities r4.4 catalogue by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/253 +* fix: add blank line after mandatory marker BEGIN by @hdamker in https://github.com/camaraproject/NumberVerification/pull/261 +* chore: remove obsolete v0 validation caller workflows by @hdamker in https://github.com/camaraproject/NumberVerification/pull/260 +* fix(number-verification): correct RFC 2119 keywords and indentation in description by @hdamker in https://github.com/camaraproject/NumberVerification/pull/263 +* Release Automation: Post-release sync (r4.1) by @camara-release-automation[bot] in https://github.com/camaraproject/NumberVerification/pull/264 +* Update release plan for Number Verification (public-version) by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/265 + +## New Contributors +* @jpengar made their first contribution in https://github.com/camaraproject/NumberVerification/pull/226 +* @albertoramosmonagas made their first contribution in https://github.com/camaraproject/NumberVerification/pull/238 + +
+ + +## number-verification 2.1.1 + +**number-verification 2.1.1 is a patch update of this API.** + +Changes documented below are compared to version 2.1.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r4.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/r4.2/code/API_definitions/number-verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r4.2/code/API_definitions/number-verification.yaml) + +### Breaking changes + +* N/A + +### Added + +* Added access token requirements for Number Verification scopes: tokens are single-use, refresh tokens are not issued, and expiry is at most 300 seconds by @jpengar in https://github.com/camaraproject/NumberVerification/pull/226 +* Added companion whitepaper: Operator Token Acquisition for Number Verification on Android (TS.43/OpenID4VP) by @albertoramosmonagas in https://github.com/camaraproject/NumberVerification/pull/238 + +### Changed + +* Refactored DevicePhoneNumber reference in YAML by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/249 +* Aligned with Commonalities r4.4 (0.9.0) by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/235 and @hdamker in https://github.com/camaraproject/NumberVerification/pull/252: + * Error responses changed to reference `BadRequest400` and `Unauthenticated401` instead of `Generic400` / `Generic401`; error examples moved to `components/examples` by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/253 + * `maxLength` added to `phoneNumber`, `hashedPhoneNumber`, `x-correlator` and the `ErrorInfo` properties (no change in accepted values) + * Tag names changed to `Phone Number Verify` / `Phone Number Share` + * Added the mandatory "Request body strictness" section to `info.description` + +### Fixed + +* fix(number-verification): corrected Gherkin test definition defects by @hdamker in https://github.com/camaraproject/NumberVerification/pull/255 +* test(number-verification): added missing 400 scenario for phoneNumberShare by @hdamker in https://github.com/camaraproject/NumberVerification/pull/257 +* Corrected externalDocs.description wording in number-verification.yaml by @hdamker in https://github.com/camaraproject/NumberVerification/pull/240 +* fix(number-verification): corrected RFC 2119 keywords and indentation in description by @hdamker in https://github.com/camaraproject/NumberVerification/pull/263 + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/NumberVerification/compare/r3.2...r4.2 + # r4.1 ## Release Notes