Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions CHANGELOG/CHANGELOG-r4.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!-- TOC:START -->
## Table of Contents
- **[r4.2](#r42)**
- [r4.1](#r41)
<!-- TOC:END -->

Expand All @@ -14,6 +15,59 @@ 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)

## 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
Expand Down
13 changes: 3 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,14 @@ 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**.

* 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 [r4.2](https://github.com/camaraproject/NumberVerification/releases/tag/r4.2) (Sync26), with the following API versions:
* **number-verification 2.1.1**
[[YAML]](https://github.com/camaraproject/NumberVerification/blob/r4.2/code/API_definitions/number-verification.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r4.2/code/API_definitions/number-verification.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NumberVerification/r4.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](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._
<!-- CAMARA:RELEASE-INFO:END -->

Expand Down
Loading