Skip to content
Open
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
124 changes: 124 additions & 0 deletions CHANGELOG/CHANGELOG-r2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
# Changelog DeviceDataVolume

<!-- TOC:START -->
## Table of Contents
- [r2.1](#r21)
<!-- TOC:END -->

**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

# r2.1

## Release Notes

This release candidate contains the definition and documentation of
* device-data-volume-subscriptions 0.2.0-rc.1
* device-data-volume 0.2.0-rc.1

The API definition(s) are based on
* Commonalities 0.8.0
* Identity and Consent Management 0.5.0

<!-- BEGIN:AUTOGENERATED:CANDIDATE_CHANGES -->
> **Working area — candidate changes (auto-removed on merge)**
> Copy relevant entries into the Added/Changed/Fixed/Removed sections below.
> 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/DeviceDataVolume/pull/71
* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/DeviceDataVolume/pull/72
* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/DeviceDataVolume/pull/73
* Remove sinkCredential from Subscription schema by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/76
* Update automation branch to fix validation error by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/77
* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceDataVolume/pull/75
* Update release plan for Sync26 by @rartych in https://github.com/camaraproject/DeviceDataVolume/pull/74
* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DeviceDataVolume/pull/79
* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/81
* Delete redundant API Readiness Checklists by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/85

## New Contributors
* @camara-release-automation[bot] made their first contribution in https://github.com/camaraproject/DeviceDataVolume/pull/75
* @rartych made their first contribution in https://github.com/camaraproject/DeviceDataVolume/pull/74

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

## device-data-volume-subscriptions 0.2.0-rc.1

**device-data-volume-subscriptions 0.2.0-rc.1 is a release-candidate version of this API.**

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.1/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.1/code/API_definitions/device-data-volume-subscriptions.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceDataVolume/blob/r2.1/code/API_definitions/device-data-volume-subscriptions.yaml)

### Breaking changes

* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/81
- Pagination for listing of subscriptions using GET /subscriptions is now supported
- Addition of `page` and `perPage` query parameters to control pagination
- Returned subscriptions are now embedded in the array `subscriptions` within the response JSON, with the page tracked within the `pagination` JSON
- Addition of response headers `X-Total-Count`, `X-Total-Pages` and `Link` to facilitate page navigation

### Added

* N/A

### Changed

* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/81
- Pagination for listing of subscriptions using GET /subscriptions is now supported
- Addition of `page` and `perPage` query parameters to control pagination
- Returned subscriptions are now embedded in the array `subscriptions` within the response JSON, with the page tracked within the `pagination` JSON
- Addition of response headers `X-Total-Count`, `X-Total-Pages` and `Link` to facilitate page navigation

### Fixed

* N/A

### Removed

* Delete redundant API Readiness Checklists by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/85

## device-data-volume 0.2.0-rc.1

**device-data-volume 0.2.0-rc.1 is a release-candidate version of this API.**

- API definition **with inline documentation**:
- [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.1/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.1/code/API_definitions/device-data-volume.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DeviceDataVolume/blob/r2.1/code/API_definitions/device-data-volume.yaml)

### Breaking changes

* N/A

### Added

* N/A

### Changed

* Update API definitions to fix CAMARA validation warnings and hints by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/81

### Fixed

* N/A

### Removed

* Delete redundant API Readiness Checklists by @eric-murray in https://github.com/camaraproject/DeviceDataVolume/pull/85

**Full Changelog**: https://github.com/camaraproject/DeviceDataVolume/compare/r1.3...r2.1

26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,24 @@ Sandbox API Repository to describe, develop, document, and test the DeviceDataVo
> [!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 [r1.3](https://github.com/camaraproject/DeviceDataVolume/releases/tag/r1.3) (Fall25), with the following API versions:
* **device-data-volume-subscriptions v0.1.0**
[[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml)
* **device-data-volume v0.1.0**
[[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume.yaml)
[[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml&nocors)
[[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml)
* The latest public release is [r1.3](https://github.com/camaraproject/DeviceDataVolume/releases/tag/r1.3), with the following API versions:
* **device-data-volume-subscriptions 0.1.0**
[[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume-subscriptions.yaml)
* **device-data-volume 0.1.0**
[[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r1.3/code/API_definitions/device-data-volume.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r1.3/code/API_definitions/device-data-volume.yaml)

* The latest public release is always available here: https://github.com/camaraproject/DeviceDataVolume/releases/latest
* Other releases of this repository are available in https://github.com/camaraproject/DeviceDataVolume/releases
* For changes see [CHANGELOG.md](https://github.com/camaraproject/DeviceDataVolume/blob/main/CHANGELOG.md)
* For changes see [CHANGELOG](https://github.com/camaraproject/DeviceDataVolume/tree/main/CHANGELOG)

### Upcoming Release Preview

* Pre-release: [r2.1](https://github.com/camaraproject/DeviceDataVolume/releases/tag/r2.1) (release candidate)
* **device-data-volume-subscriptions 0.2.0-rc.1**
[[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r2.1/code/API_definitions/device-data-volume-subscriptions.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.1/code/API_definitions/device-data-volume-subscriptions.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.1/code/API_definitions/device-data-volume-subscriptions.yaml)
* **device-data-volume 0.2.0-rc.1**
[[YAML]](https://github.com/camaraproject/DeviceDataVolume/blob/r2.1/code/API_definitions/device-data-volume.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.1/code/API_definitions/device-data-volume.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DeviceDataVolume/r2.1/code/API_definitions/device-data-volume.yaml)


_The above section is automatically synchronized by CAMARA project-administration._
<!-- CAMARA:RELEASE-INFO:END -->
Expand Down
Loading