diff --git a/CHANGELOG/CHANGELOG-r4.md b/CHANGELOG/CHANGELOG-r4.md new file mode 100644 index 0000000..161d19c --- /dev/null +++ b/CHANGELOG/CHANGELOG-r4.md @@ -0,0 +1,63 @@ +# Changelog NumberVerification + + +## Table of Contents +- [r4.1](#r41) + + +**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 + +# r4.1 + +## Release Notes + +This release candidate contains the definition and documentation of +* number-verification 2.1.1-rc.2 + +The API definition(s) are based on +* Commonalities r4.4 (0.9.0) +* Identity and Consent Management r4.2 (0.5.0) + +## number-verification 2.1.1-rc.2 + +**number-verification 2.1.1-rc.2 is a release-candidate version 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.1/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.1/code/API_definitions/number-verification.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NumberVerification/blob/r4.1/code/API_definitions/number-verification.yaml) + +### Breaking changes + +* N/A + +### Added + +* Access token security considerations for Number Verification API by @jpengar in https://github.com/camaraproject/NumberVerification/pull/226 +* Add companion whitepaper: Operator Token Acquisition for Number Verification on Android (TS.43/OpenID4VP) by @albertoramosmonagas in https://github.com/camaraproject/NumberVerification/pull/238 + +### Changed + +* Refactor DevicePhoneNumber reference in YAML by @bigludo7 in https://github.com/camaraproject/NumberVerification/pull/249 + +### Fixed + +* fix(number-verification): correct Gherkin test definition defects by @hdamker in https://github.com/camaraproject/NumberVerification/pull/255 +* test(number-verification): add missing 400 scenario for phoneNumberShare by @hdamker in https://github.com/camaraproject/NumberVerification/pull/257 +* Correct externalDocs.description wording in number-verification.yaml by @hdamker in https://github.com/camaraproject/NumberVerification/pull/240 + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/NumberVerification/compare/r3.2...r4.1 + diff --git a/README.md b/README.md index 515bcfb..471fd75 100644 --- a/README.md +++ b/README.md @@ -31,14 +31,20 @@ Incubating API Repository to evolve and maintain the definitions and documentati > [!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**. -* **NEW**: The latest public release is [r3.2](https://github.com/camaraproject/NumberVerification/releases/tag/r3.2) (Fall25), with the following API versions: - * **number-verification v2.1.0** - [[YAML]](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml) - [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors) - [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml) +* The latest public release is [r3.2](https://github.com/camaraproject/NumberVerification/releases/tag/r3.2), with the following API versions: + * **number-verification 2.1.0** + [[YAML]](https://github.com/camaraproject/NumberVerification/blob/r3.2/code/API_definitions/number-verification.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r3.2/code/API_definitions/number-verification.yaml) + * The latest public release is always available here: https://github.com/camaraproject/NumberVerification/releases/latest * Other releases of this repository are available in https://github.com/camaraproject/NumberVerification/releases -* For changes see [CHANGELOG.md](https://github.com/camaraproject/NumberVerification/blob/main/CHANGELOG.md) +* For changes see [CHANGELOG](https://github.com/camaraproject/NumberVerification/tree/main/CHANGELOG) + +### Upcoming Release Preview + +* Pre-release: [r4.1](https://github.com/camaraproject/NumberVerification/releases/tag/r4.1) (release candidate) + * **number-verification 2.1.1-rc.2** + [[YAML]](https://github.com/camaraproject/NumberVerification/blob/r4.1/code/API_definitions/number-verification.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r4.1/code/API_definitions/number-verification.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r4.1/code/API_definitions/number-verification.yaml) + _The above section is automatically synchronized by CAMARA project-administration._