Skip to content
Open
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
175 changes: 175 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.3](#r23)
- [r2.2](#r22)
- [r2.1](#r21)
<!-- TOC:END -->
Expand All @@ -15,6 +16,180 @@ 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.3

## Release Notes

This release candidate contains the definition and documentation of
* dedicated-network-accesses 0.2.0-rc.2
* dedicated-network-profiles 0.2.0-rc.2
* dedicated-network 0.2.0-rc.2
* dedicated-network-areas 0.1.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
* chore: remove obsolete v0 validation caller workflows by @hdamker in https://github.com/camaraproject/DedicatedNetworks/pull/185
* Release Automation: Post-release sync (r2.2) by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/187
* Update release-plan.yaml with Commonalities release r4.4 and target release r2.3 by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/190
* Addressing remaining r2.2 review issues by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/179
* Sync common files from Commonalities r4.4 by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/191
* Upgrade API definitions to Commonalities r4.4 (#188) by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194
* Add test scenarios for the Dedicated Network Accesses API by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/195
* Use int32-range bounds for arrays and device counters (#145) by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/196
* Adding support for three-legged access token by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/197
* Add test scenarios for three-legged access token support by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/198

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

## dedicated-network-accesses 0.2.0-rc.2

**dedicated-network-accesses 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/DedicatedNetworks/r2.3/code/API_definitions/dedicated-network-accesses.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.3/code/API_definitions/dedicated-network-accesses.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r2.3/code/API_definitions/dedicated-network-accesses.yaml)

### Breaking changes

* Reworked access device handling: the `x-device` header is replaced by the `accessDeviceId` query parameter to query accesses by device, and `recentAccessDevices` is replaced by `addedAccessDevices` by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/179
* Aligned with Commonalities r4.4 (0.9.0): invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403, except for single-device operations called with a three-legged access token by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194
* Moved the `addedAt` timestamp from the operation response body to each added `AccessDevice` by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/197

### Added

* Added a stable `accessDeviceId` (used to read and remove a single access device and to query accesses by device), time-based filters for listing access devices and an optional access `name` by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/179
* Added three-legged access token support for single-device operations, including a new `POST /accesses/{accessId}/devices` operation and the `dedicated-network-accesses:device:create` scope. Single-device operations (add/read/delete) now accept two-legged or three-legged tokens; multiple-device and access-level operations remain two-legged only by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/197
* Added success and error test scenarios for all nine Accesses API operations by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/195
* Added test scenarios for three-legged access token support by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/198

### Changed

* Reworked access device handling: added a stable `accessDeviceId` (used to read and remove a single access device and to query accesses by device, replacing the `x-device` header), replaced `recentAccessDevices` with `addedAccessDevices`, added time-based filters for listing access devices and an optional access `name`, and removed unused `ErrorResultForDevice` codes by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/179
* Aligned with Commonalities r4.4 (0.9.0): replaced the deprecated `Generic*` error responses with the r4.4 common responses and the common `Sink` schema, and updated the test definitions; invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403, except for single-device operations called with a three-legged access token by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194
* Use int32-range bounds for array sizes and device counters by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/196
* Moved the `addedAt` timestamp from the operation response body to each added `AccessDevice`, and aligned the `createAccess` outcomes (201, 207, 422 `DEDICATED_NETWORK_ACCESSES.NO_VALID_DEVICE`) with `addDevicesToAccess` by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/197
* Split accesses test definitions into access, multiple-device and single-device feature files, and changed the different-API-client cases to 404 NOT_FOUND by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/198

### Fixed

* Fixed existing test scenarios to match the current API definition by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/195

### Removed

* Removed the `x-device` header and unused `ErrorResultForDevice` codes by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/179

## dedicated-network-profiles 0.2.0-rc.2

**dedicated-network-profiles 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/DedicatedNetworks/r2.3/code/API_definitions/dedicated-network-profiles.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.3/code/API_definitions/dedicated-network-profiles.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r2.3/code/API_definitions/dedicated-network-profiles.yaml)

### Breaking changes

* Aligned with Commonalities r4.4 (0.9.0): invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403 by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194

### Added

* N/A

### Changed

* Aligned with Commonalities r4.4 (0.9.0): replaced the deprecated `Generic*` error responses with the r4.4 common responses, and updated the test definitions; invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403 by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194
* Use int32-range bounds for `maxNumberOfDevices` by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/196

### Fixed

* N/A

### Removed

* N/A

## dedicated-network 0.2.0-rc.2

**dedicated-network 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/DedicatedNetworks/r2.3/code/API_definitions/dedicated-network.yaml&nocors)
- [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.3/code/API_definitions/dedicated-network.yaml)
- OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r2.3/code/API_definitions/dedicated-network.yaml)

### Breaking changes

* Aligned with Commonalities r4.4 (0.9.0): invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403 by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194

### Added

* N/A

### Changed

* Aligned with Commonalities r4.4 (0.9.0): replaced the deprecated `Generic*` error responses with the r4.4 common responses and the common `Sink` schema, and updated the test definitions; invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403 by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194

### Fixed

* N/A

### Removed

* N/A

## dedicated-network-areas 0.1.0-rc.2

**dedicated-network-areas 0.1.0-rc.2 is a release-candidate version of this API.**

Changes documented below are compared to version 0.1.0-rc.1.

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

### Breaking changes

* Aligned with Commonalities r4.4 (0.9.0): invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403 by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194

### Added

* N/A

### Changed

* Aligned with Commonalities r4.4 (0.9.0): replaced the deprecated `Generic*` error responses with the r4.4 common responses, and updated the test definitions; invalid pagination parameters now return 400 `INVALID_ARGUMENT` and `INVALID_TOKEN_CONTEXT` is no longer returned with 403 by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/194

### Fixed

* N/A

### Removed

* N/A

**Full Changelog**: https://github.com/camaraproject/DedicatedNetworks/compare/r2.2...r2.3

# r2.2

## Release Notes
Expand Down
Loading