Skip to content
Closed
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
118 changes: 118 additions & 0 deletions CHANGELOG/CHANGELOG-r2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

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

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

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

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

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

* [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 checkDataVolume, retrieveDataVolume and createDeviceDataVolumeSubscription operations
* Add 401 error test cases for all operations
* Add 422 error test cases for createDeviceDataVolumeSubscription operations

### Changed

* [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
* Make subscriptionDetail 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

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

* [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 device-data-volume all endpoints
* Remove 404 IDENTIFIER_NOT_FOUND from device-data-volume-subscriptions retrieval and deletion

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

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

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

### Fixed

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

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

# r2.1

## Release Notes
Expand Down
Loading