From 5f10654e63583a15dbdb303b81d47f57b88932e4 Mon Sep 17 00:00:00 2001 From: "camara-release-automation[bot]" <261643975+camara-release-automation[bot]@users.noreply.github.com> Date: Mon, 12 Oct 2026 10:17:59 +0000 Subject: [PATCH 1/6] Add CHANGELOG draft for r2.2 --- CHANGELOG/CHANGELOG-r2.md | 101 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index 46426d3..70a5d6e 100644 --- a/CHANGELOG/CHANGELOG-r2.md +++ b/CHANGELOG/CHANGELOG-r2.md @@ -2,6 +2,7 @@ ## Table of Contents +- [r2.2](#r22) - [r2.1](#r21) @@ -14,6 +15,106 @@ 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 +# r2.2 + +## Release Notes + +This release candidate contains the definition and documentation of +* device-data-volume-subscriptions 0.2.0-rc.2 +* device-data-volume 0.2.0-rc.2 + +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 +* Release Automation: Post-release sync (r2.1) by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceDataVolume/pull/125 +* [Changed] Improve API documentation by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/129 +* [Fixed] Fix feature files for device-data-volume by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/128 +* [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 +* [Changed] Increase maximum data allowance limit by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/126 +* [Updated / Fixed / Added] Refactor test cases for updated API definitions by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/130 +* [Admin] Update target release tag to r2.2 by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/131 +* [Fixed] Typo corrections by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/141 +* [Changed] Update response reference for unprocessable entity and improved initialEvent description by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/138 +* [Fixed] Fix typos in test case feature files by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/139 + +
+ + +## device-data-volume-subscriptions 0.2.0-rc.2 + +**device-data-volume-subscriptions 0.2.0-rc.2 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.2.0-rc.1. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.2/code/API_definitions/device-data-volume-subscriptions.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.2/code/API_definitions/device-data-volume-subscriptions.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceDataVolume/blob/r2.2/code/API_definitions/device-data-volume-subscriptions.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +## device-data-volume 0.2.0-rc.2 + +**device-data-volume 0.2.0-rc.2 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.2.0-rc.1. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.2/code/API_definitions/device-data-volume.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.2/code/API_definitions/device-data-volume.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceDataVolume/blob/r2.2/code/API_definitions/device-data-volume.yaml) + +### Breaking changes + +* N/A + +### Added + +* N/A + +### Changed + +* N/A + +### Fixed + +* N/A + +### Removed + +* N/A + +**Full Changelog**: https://github.com/camaraproject/DeviceDataVolume/compare/r2.1...r2.2 + # r2.1 ## Release Notes From 7005238cc659704d6cd72370257a7e72717af037 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Mon, 12 Oct 2026 11:29:00 +0100 Subject: [PATCH 2/6] Update CHANGELOG for API changes in r2.2 Updated changelog to reflect breaking changes, additions, modifications, fixes, and removals in the API. Notable changes include updates to error response codes and test cases. --- CHANGELOG/CHANGELOG-r2.md | 43 ++++++++++++++++++++++++++++++--------- 1 file changed, 33 insertions(+), 10 deletions(-) diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index 70a5d6e..76950d8 100644 --- a/CHANGELOG/CHANGELOG-r2.md +++ b/CHANGELOG/CHANGELOG-r2.md @@ -64,23 +64,37 @@ Changes documented below are compared to version 0.2.0-rc.1. ### Breaking changes -* N/A +* [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 + * Property subscriptionDetail is now a required subscription creation parameter ### Added -* N/A +* [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 + * Add 404 IDENTIFIER_NOT_FOUND to device-data-volume-subscriptions creation +* [Updated / Fixed / Added] Refactor test cases for updated API definitions by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/130 + * Add additional test cases + * Add 429 error test cases for createDeviceDataVolumeSubscription operations + * Add 401 error test cases for all operations + * Add 422 error test cases for createDeviceDataVolumeSubscription operations ### Changed -* N/A +* [Changed] Improve API documentation by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/129 +* [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 + * Property subscriptionDetail is now a required subscription creation parameter +* [Updated / Fixed / Added] Refactor test cases for updated API definitions by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/130 + * Move test definitions to separate files for each defined operation ### Fixed -* N/A +* [Updated / Fixed / Added] Refactor test cases for updated API definitions by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/130 + * Fix typos in test case definitions ### Removed -* N/A +* [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 + * Remove 404 IDENTIFIER_NOT_FOUND from device-data-volume-subscriptions retrieval and deletion + * Removed OUT_OF_RANGE from the 400 response of GET /subscriptions, and INCOMPATIBLE_STATE from the 409 response of POST /subscriptions ## device-data-volume 0.2.0-rc.2 @@ -95,23 +109,32 @@ Changes documented below are compared to version 0.2.0-rc.1. ### Breaking changes -* N/A +* [Changed] Increase maximum data allowance limit by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/126 + * The max of `remainingDataAllowance.value` in the POST /retrieve 200 response increased from 1000 to 99999 (response-property-max-increased) ### Added -* N/A +* [Updated / Fixed / Added] Refactor test cases for updated API definitions by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/130 + * Add additional test cases + * Add 401 and 429 error test cases for checkDataVolume and retrieveDataVolume ### Changed -* N/A +* [Changed] Improve API documentation by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/129 +* [Changed] Increase maximum data allowance limit by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/126 + * The max of `remainingDataAllowance.value` in the POST /retrieve 200 response increased from 1000 to 99999 (response-property-max-increased) ### Fixed -* N/A +* [Fixed] Fix feature files for device-data-volume by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/128 + * Change remaining references to response body property $.dataAllowance to new property name $.remainingDataAllowance +* [Updated / Fixed / Added] Refactor test cases for updated API definitions by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/130 + * Fix typos in test case definitions ### Removed -* N/A +* [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 + * Remove 404 NOT_FOUND from all device-data-volume endpoints **Full Changelog**: https://github.com/camaraproject/DeviceDataVolume/compare/r2.1...r2.2 From 3a1495a76bb072f79bcdf140e55a7d7a842ad297 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Wed, 14 Oct 2026 12:08:29 +0100 Subject: [PATCH 3/6] Update CHANGELOG/CHANGELOG-r2.md Co-authored-by: Herbert Damker --- CHANGELOG/CHANGELOG-r2.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index 76950d8..8612572 100644 --- a/CHANGELOG/CHANGELOG-r2.md +++ b/CHANGELOG/CHANGELOG-r2.md @@ -66,6 +66,7 @@ Changes documented below are compared to version 0.2.0-rc.1. * [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 * Property subscriptionDetail is now a required subscription creation parameter + * Add 404 IDENTIFIER_NOT_FOUND to device-data-volume-subscriptions creation ### Added From aee93ff5dd0fec62375c82baf051c932cf738876 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Wed, 14 Oct 2026 12:09:46 +0100 Subject: [PATCH 4/6] Update CHANGELOG/CHANGELOG-r2.md Co-authored-by: Herbert Damker --- CHANGELOG/CHANGELOG-r2.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index 8612572..735aa3d 100644 --- a/CHANGELOG/CHANGELOG-r2.md +++ b/CHANGELOG/CHANGELOG-r2.md @@ -67,6 +67,10 @@ Changes documented below are compared to version 0.2.0-rc.1. * [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 * Property subscriptionDetail is now a required subscription creation parameter * Add 404 IDENTIFIER_NOT_FOUND to device-data-volume-subscriptions creation +* [Changed] Improve API documentation by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/129 + * Threshold events now trigger when the remaining data allowance is equal to the threshold, instead of below it +* [Changed] Update response reference for unprocessable entity and improved initialEvent description by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/138 + * With `initialEvent` set to true, an initial event is only sent if the remaining data allowance equals the threshold when the subscription is created ### Added From b3de64c6cad5a7e5493d1478b5ce4da1dffe5ac2 Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Wed, 14 Oct 2026 12:10:10 +0100 Subject: [PATCH 5/6] Update CHANGELOG/CHANGELOG-r2.md Co-authored-by: Herbert Damker --- CHANGELOG/CHANGELOG-r2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index 735aa3d..bb45397 100644 --- a/CHANGELOG/CHANGELOG-r2.md +++ b/CHANGELOG/CHANGELOG-r2.md @@ -127,7 +127,7 @@ Changes documented below are compared to version 0.2.0-rc.1. * [Changed] Improve API documentation by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/129 * [Changed] Increase maximum data allowance limit by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/126 - * The max of `remainingDataAllowance.value` in the POST /retrieve 200 response increased from 1000 to 99999 (response-property-max-increased) + * The max of `remainingDataAllowance.value` in the POST /retrieve 200 response and of `dataAllowanceThreshold.value` in the POST /check request increased from 1000 to 99999 ### Fixed From d7d5d18952b9b6dec54edff6b066fd5c6284045b Mon Sep 17 00:00:00 2001 From: Eric Murray Date: Wed, 14 Oct 2026 12:10:33 +0100 Subject: [PATCH 6/6] Update CHANGELOG/CHANGELOG-r2.md Co-authored-by: Herbert Damker --- CHANGELOG/CHANGELOG-r2.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index bb45397..8489590 100644 --- a/CHANGELOG/CHANGELOG-r2.md +++ b/CHANGELOG/CHANGELOG-r2.md @@ -85,6 +85,9 @@ Changes documented below are compared to version 0.2.0-rc.1. ### Changed * [Changed] Improve API documentation by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/129 + * Threshold events now trigger when the remaining data allowance is equal to the threshold, instead of below it +* [Changed] Update response reference for unprocessable entity and improved initialEvent description by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/138 + * With `initialEvent` set to true, an initial event is only sent if the remaining data allowance equals the threshold when the subscription is created * [Changed / Added / Removed] Update error response codes to use new Commonalities r4.4 schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/127 * Property subscriptionDetail is now a required subscription creation parameter * [Updated / Fixed / Added] Refactor test cases for updated API definitions by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/130