Skip to content

Release Review: DeviceIdentifier r3.5 (public Sync26) #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
camara-release-automation wants to merge 2 commits into
base: release-snapshot/r3.5-ac2cdee
Choose a base branch
from
Open

Release Review: DeviceIdentifier r3.5 (public Sync26) #239

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f35e93d
Add CHANGELOG draft for r3.5
camara-release-automation[bot] Nov 10, 2026
6b349bc
Update CHANGELOG for version r3.5
eric-murray Nov 10, 2026
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
142 changes: 142 additions & 0 deletions CHANGELOG/CHANGELOG-r3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<!-- TOC:START -->
## Table of Contents
- **[r3.5](#r35)**
- [r3.4](#r34)
- [r3.3](#r33)
- [r3.2](#r32)
Expand All @@ -17,6 +18,147 @@ 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

# r3.5

## Release Notes

This public release contains the definition and documentation of
* device-identifier 0.4.0

The API definition(s) are based on
* Commonalities r4.4 (0.9.0)
* Identity and Consent Management r4.2 (0.5.0)

<!-- BEGIN:AUTOGENERATED:CANDIDATE_CHANGES -->
> **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.

<details>
<summary>Candidate changes (auto-generated from merged PRs)</summary>

## What's Changed
* Chore: Reset version numbers to wip following meta-release by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/144
* [bulk] Sync Release Information section (2025-12-02-002) by @hdamker-bot in https://github.com/camaraproject/DeviceIdentifier/pull/149
* fix: changed networkaccessidentifier example to use example.com by @Kevsy in https://github.com/camaraproject/DeviceIdentifier/pull/147
* Update meeting schedule time in README by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/152
* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/DeviceIdentifier/pull/153
* Fix typo in test scenario 200.05 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/155
* Add match-identifier endpoint by @ALIIQBAL786 in https://github.com/camaraproject/DeviceIdentifier/pull/151
* Update release plan for Sync26 and target version 3.1 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/157
* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/161
* Sync common files from Commonalities r4.2 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/162
* Update API definition following Commonalities r4.3 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/167
* Update release plan for Commonalities r4.3 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/166
* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/169
* Add common template code to info.description by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/170
* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/165
* Release Automation: Post-release sync (r3.1) by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/173
* Delete redundant workflow files by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/175
* Update release-plan.yaml for r3.2 (0.4.0-rc.1) by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/174
* Delete redundant API Readiness Checklist by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/177
* [Fixed] Fix ipv4Address typo in feature files by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/182
* Add conformance test definitions for the new /match-identifier endpoint by @usmanTheCoder in https://github.com/camaraproject/DeviceIdentifier/pull/160
* [Fixed] Rename schema DevicePPID to use PascalCase by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/179
* [Added] Update test cases for device identifier matching by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/188
* [Changed] Update and clarify tests for applicability to 2-legged and/or 3-legged access tokens by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/189
* [Changed] Make lastChecked property nullable and add examples by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/184
* [Changed] Various documentation additions, updates and fixes for consistency, accuracy and clarity by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/198
* [Fixed] Fix test definition component references by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/197
* [Fixed] Fix examples by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/196
* [Changed] Add dedicated response body schema and update tests by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/203
* [Fixed] Documentation fixes by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/204
* [Added] Add tests for multiple device identifiers and missing end user consent by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/205
* [Changed] Refactor MatchRequestBody‎ to allow proper schema validation for provided identifier by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/202
* Release Automation: Post-release sync (r3.2) by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/207
* [Admin] Create release plan for r3.3 with compliance with Commonalities r4.4 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/208
* Sync common files from Commonalities r4.4 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/211
* [Admin] Update info.description templates to match Commonalities r4.4 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/215
* [Changed] Update error response schema using new Commonalities r4.4 schemas by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/213
* Release Automation: Post-release sync (r3.3) by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/221
* [Admin] Update release plan for public release by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/223
* [Added / Removed] Add QUOTA_EXCEEDED and remove OUT_OF_RANGE error response codes by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/225
* Another release candidate is required by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/226
* Release Automation: Post-release sync (r3.4) by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceIdentifier/pull/231
* [Fixed] Remove 400 OUT_OF_RANGE as a valid error response code from test scenarios by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/232
* [Admin] Update release plan for public release by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/233
* [Fixed] Fix typos, add missing elements, and remove ambiguities in test definitions by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/237

## New Contributors
* @ALIIQBAL786 made their first contribution in https://github.com/camaraproject/DeviceIdentifier/pull/151
* @usmanTheCoder made their first contribution in https://github.com/camaraproject/DeviceIdentifier/pull/160

</details>
<!-- END:AUTOGENERATED:CANDIDATE_CHANGES -->

## device-identifier 0.4.0

**device-identifier 0.4.0 is an initial public version of this API.**

Changes documented below are compared to version 0.3.0.

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r3.5/code/API_definitions/device-identifier.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r3.5/code/API_definitions/device-identifier.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceIdentifier/blob/r3.5/code/API_definitions/device-identifier.yaml)

### Breaking changes

* Mandatory response property `lastChecked` can now be set to `null` by the API provider if they do not have this information

### Added

* New match-identifier endpoint added
* Originally by @ALIIQBAL786 in https://github.com/camaraproject/DeviceIdentifier/pull/151
* Updated by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/202

* [Added / Removed] Add QUOTA_EXCEEDED and remove OUT_OF_RANGE error response codes by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/225
* Add test cases for 429 error responses:
* @DeviceIdentifier_matchIdentifier_429.01_Too_Many_Requests
* @DeviceIdentifier_matchIdentifier_429.02_Quota_Exceeded
* @DeviceIdentifier_retrieveIdentifier_429.01_Too_Many_Requests
* @DeviceIdentifier_retrieveIdentifier_429.02_Quota_Exceeded
* @DeviceIdentifier_retrievePpid_429.01_Too_Many_Requests
* @DeviceIdentifier_retrievePpid_429.02_Quota_Exceeded
* @DeviceIdentifier_retrieveType_429.01_Too_Many_Requests
* @DeviceIdentifier_retrieveType_429.02_Quota_Exceeded
* Add common template code to info.description by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/170
* Add conformance test definitions for the new /match-identifier endpoint by @usmanTheCoder in https://github.com/camaraproject/DeviceIdentifier/pull/160
* [Added] Update test cases for device identifier matching by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/188
* [Added] Add tests for multiple device identifiers and missing end user consent by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/205

### Changed

* Update API definition following Commonalities r4.3 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/167
* Use header, parameter and schema definition from Commonalities where possible rather than maintain local copies
* Add `maxLength` directive for all strings
* Free-form `model` and `manufacturer` strings now limited to 32 characters
* Tightening of `ppid` format by adding `minLength: 64`, `maxLength: 128`, and `pattern: ^[a-fA-F0-9]{64,128}$` constraints
* [Changed] Update and clarify tests for applicability to 2-legged and/or 3-legged access tokens by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/189
* [Changed] Make lastChecked property nullable and add examples by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/184
* [Changed] Various documentation additions, updates and fixes for consistency, accuracy and clarity by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/198
* [Changed] Add dedicated response body schema and update tests by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/203
* fix: changed networkaccessidentifier example to use example.com by @Kevsy in https://github.com/camaraproject/DeviceIdentifier/pull/147

### Fixed

* Fix typo in test scenario 200.05 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/155
* [Fixed] Fix ipv4Address typo in feature files by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/182
* [Fixed] Rename schema DevicePPID to use PascalCase by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/179
* [Fixed] Fix test definition component references by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/197
* [Fixed] Fix examples by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/196
* [Fixed] Documentation fixes by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/204
* [Fixed] Fix typos, add missing elements, and remove ambiguities in test definitions by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/237

### Removed

* [Added / Removed] Add QUOTA_EXCEEDED and remove OUT_OF_RANGE error response codes by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/225
* Remove 400 OUT_OF_RANGE as a valid error response code, as all schema non-compliance will be caught by 400 INVALID_REQUEST
* Associated test cases removed by https://github.com/camaraproject/DeviceIdentifier/pull/232

**Full Changelog**: https://github.com/camaraproject/DeviceIdentifier/compare/r2.2...r3.5

# r3.4

## Release Notes
Expand Down
Loading