diff --git a/CHANGELOG/CHANGELOG-r3.md b/CHANGELOG/CHANGELOG-r3.md index 48d8332..771575d6 100644 --- a/CHANGELOG/CHANGELOG-r3.md +++ b/CHANGELOG/CHANGELOG-r3.md @@ -2,6 +2,7 @@ ## Table of Contents +- [r3.2](#r32) - [r3.1](#r31) @@ -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 +# r3.2 + +## Release Notes + +This release candidate contains the definition and documentation of +* device-identifier 0.4.0-rc.1 + +The API definition(s) are based on +* Commonalities 0.8.0 +* Identity and Consent Management 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 @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 + +## 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 + +
+ + +## device-identifier 0.4.0-rc.1 + +**device-identifier 0.4.0-rc.1 is a release-candidate 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.2/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.2/code/API_definitions/device-identifier.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceIdentifier/blob/r3.2/code/API_definitions/device-identifier.yaml) + +### Breaking changes + +* Mandatory response property `lastChecked` can now be set to `null` if the API provider does not have this information + +### Added + +* Add match-identifier endpoint by @ALIIQBAL786 in https://github.com/camaraproject/DeviceIdentifier/pull/151 +* 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 + +### Changed + +* fix: changed networkaccessidentifier example to use example.com by @Kevsy in https://github.com/camaraproject/DeviceIdentifier/pull/147 +* Update API definition following Commonalities r4.3 by @eric-murray in https://github.com/camaraproject/DeviceIdentifier/pull/167 +* [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 + +### 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 + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/DeviceIdentifier/compare/r2.2...r3.2 + # r3.1 ## Release Notes diff --git a/README.md b/README.md index 754e291..fd4ce21 100644 --- a/README.md +++ b/README.md @@ -40,9 +40,9 @@ API Repository [wiki page](https://lf-camaraproject.atlassian.net/wiki/x/czLe) ### Upcoming Release Preview -* Pre-release: [r3.1](https://github.com/camaraproject/DeviceIdentifier/releases/tag/r3.1) (alpha) - * **device-identifier 0.4.0-alpha.1** - [[YAML]](https://github.com/camaraproject/DeviceIdentifier/blob/r3.1/code/API_definitions/device-identifier.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r3.1/code/API_definitions/device-identifier.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r3.1/code/API_definitions/device-identifier.yaml) +* Pre-release: [r3.2](https://github.com/camaraproject/DeviceIdentifier/releases/tag/r3.2) (release candidate) + * **device-identifier 0.4.0-rc.1** + [[YAML]](https://github.com/camaraproject/DeviceIdentifier/blob/r3.2/code/API_definitions/device-identifier.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r3.2/code/API_definitions/device-identifier.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceIdentifier/r3.2/code/API_definitions/device-identifier.yaml) _The above section is automatically synchronized by CAMARA project-administration._