diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index 237eb56..7a0027b 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,216 @@ 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 +* dedicated-network-accesses 0.2.0-rc.1 +* dedicated-network-profiles 0.2.0-rc.1 +* dedicated-network 0.2.0-rc.1 +* dedicated-network-areas 0.1.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 +* Reset to wip after r1.2 by @rkandoi in https://github.com/camaraproject/DedicatedNetworks/pull/80 +* Update README to point to QOS Sub Project by @rkandoi in https://github.com/camaraproject/DedicatedNetworks/pull/77 +* Update sub project name and mailing list details in README by @hdamker in https://github.com/camaraproject/DedicatedNetworks/pull/82 +* Updating meeting time to 0900h UTC by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/84 +* Format profile id as UUID by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/83 +* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/DedicatedNetworks/pull/89 +* New error code when network in wrong state by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/81 +* Areas API proposal by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/87 +* Support device access states and state notifications by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/91 +* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/DedicatedNetworks/pull/94 +* Adding description of the MaxNumberOfDevices parameter by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/88 +* New network name property by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/97 +* [bulk] Enable release automation and validation by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/101 +* Support operations to manage access to dedicated network for multiple devices at a time by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/98 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/105 +* Release plan for r2.1 by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/99 +* Release Automation: Post-release sync (r2.1) by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/109 +* Release plan for r2.2 by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/110 +* Fix r2.2 sync validation errors by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/118 +* Merge main into sync-common/r4.3 by @hdamker in https://github.com/camaraproject/DedicatedNetworks/pull/119 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/115 +* Fix global tags for dedicted network areas and profiles by @jordijoangimenez in https://github.com/camaraproject/DedicatedNetworks/pull/117 +* Update pagination to align with commonalities by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/122 +* Mandatory info.description template elements by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/121 +* Fix: align CloudEvent schemas with Commonalities pattern by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/120 +* Fix/use common schemas by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/123 +* Fix missing description warnings across the DN APIs by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/124 +* Addressing limit restrictions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/95 +* Updating API test definitions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/102 +* Add pagination for network profiles by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/125 +* Adding missing range restriction for strings in query line by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/126 +* Correcting URL in API test definition file by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/127 +* Release Management review corrections by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/136 +* fix: remove three-legged access token note from createAccess operation by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/140 +* fix: add missing x-correlator request parameter and response header by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/141 + +## New Contributors +* @hubertp-ericsson made their first contribution in https://github.com/camaraproject/DedicatedNetworks/pull/83 +* @jordijoangimenez made their first contribution in https://github.com/camaraproject/DedicatedNetworks/pull/117 +* @jimfengjinhua made their first contribution in https://github.com/camaraproject/DedicatedNetworks/pull/120 + +
+ + +## dedicated-network-accesses 0.2.0-rc.1 + +**dedicated-network-accesses 0.2.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.1.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/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.2/code/API_definitions/dedicated-network-accesses.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network-accesses.yaml) + +### Breaking changes + +* Support operations to manage access to dedicated network for multiple devices at a time by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/98 +* Update pagination to align with commonalities by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/122 + +### Added + +* Support device access states and state notifications by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/91 +* New error code when network in wrong state by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/81 + +### Changed + +* Adding description of the MaxNumberOfDevices parameter by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/88 +* Addressing limit restrictions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/95 +* Updating API test definitions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/102 +* Mandatory info.description template elements by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/121 + +### Fixed + +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/115 +* Fix r2.2 sync validation errors by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/118 +* Fix: align CloudEvent schemas with Commonalities pattern by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/120 +* Fix/use common schemas by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/123 +* Fix missing description warnings across the DN APIs by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/124 +* Addressing critical Release Management review corrections (on three-legged access token) by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/136 +* fix: add missing x-correlator request parameter and response header by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/141 + +## dedicated-network-profiles 0.2.0-rc.1 + +**dedicated-network-profiles 0.2.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.1.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/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.2/code/API_definitions/dedicated-network-profiles.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network-profiles.yaml) + +### Breaking changes + +* Format profile id as UUID by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/83 +* Add pagination for network profiles by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/125 + +### Changed + +* Adding description of the MaxNumberOfDevices parameter by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/88 +* Addressing limit restrictions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/95 +* Adding missing range restriction for strings in query line by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/126 +* Mandatory info.description template elements by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/121 + +### Fixed + +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/115 +* Fix global tags for dedicted network areas and profiles by @jordijoangimenez in https://github.com/camaraproject/DedicatedNetworks/pull/117 +* Fix/use common schemas by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/123 +* Fix missing description warnings across the DN APIs by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/124 +* fix: add missing x-correlator request parameter and response header by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/141 + +## dedicated-network 0.2.0-rc.1 + +**dedicated-network 0.2.0-rc.1 is a release-candidate version of this API.** + +Changes documented below are compared to version 0.1.0. + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/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.2/code/API_definitions/dedicated-network.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network.yaml) + +### Breaking changes + +* Areas API proposal (usage of Area Id) by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/87 +* Format profile id as UUID by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/83 + +### Added + +* New error code when network in wrong state by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/81 +* New network name property by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/97 + +### Changed + +* Addressing limit restrictions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/95 +* Updating API test definitions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/102 +* Adding missing range restriction for strings in query line by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/126 +* Mandatory info.description template elements by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/121 + +### Fixed + +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/115 +* Fix r2.2 sync validation errors by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/118 +* Fix: align CloudEvent schemas with Commonalities pattern by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/120 +* Fix/use common schemas by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/123 +* Fix missing description warnings across the DN APIs by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/124 +* fix: add missing x-correlator request parameter and response header by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/141 + +## dedicated-network-areas 0.1.0-rc.1 + +**dedicated-network-areas 0.1.0-rc.1 is the first 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/DedicatedNetworks/r2.2/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.2/code/API_definitions/dedicated-network-areas.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network-areas.yaml) + +### Added + +* Areas API proposal by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/87 +* Updating API test definitions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/102 + +### Changed + +* Addressing limit restrictions by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/95 +* Correcting URL in API test definition file by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/127 +* Mandatory info.description template elements by @tlohmar in https://github.com/camaraproject/DedicatedNetworks/pull/121 + +### Fixed + +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/DedicatedNetworks/pull/115 +* Fix global tags for dedicted network areas and profiles by @jordijoangimenez in https://github.com/camaraproject/DedicatedNetworks/pull/117 +* Fix r2.2 sync validation errors by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/118 +* Fix/use common schemas by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/123 +* Fix missing description warnings across the DN APIs by @hubertp-ericsson in https://github.com/camaraproject/DedicatedNetworks/pull/124 +* fix: add missing x-correlator request parameter and response header by @jimfengjinhua in https://github.com/camaraproject/DedicatedNetworks/pull/141 + +## New Contributors +* @hubertp-ericsson made their first contribution in https://github.com/camaraproject/DedicatedNetworks/pull/83 +* @jordijoangimenez made their first contribution in https://github.com/camaraproject/DedicatedNetworks/pull/117 +* @jimfengjinhua made their first contribution in https://github.com/camaraproject/DedicatedNetworks/pull/120 + +**Full Changelog**: https://github.com/camaraproject/DedicatedNetworks/compare/r1.2...r2.2 + # r2.1 ## Release Notes diff --git a/README.md b/README.md index 0e4c9ce..c6b0c94 100644 --- a/README.md +++ b/README.md @@ -53,15 +53,15 @@ For background on Dedicated Networks concepts and workflows, see the [General De ### Upcoming Release Preview -* Pre-release: [r2.1](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r2.1) (alpha) - * **dedicated-network-accesses 0.2.0-alpha.1** - [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.1/code/API_definitions/dedicated-network-accesses.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network-accesses.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network-accesses.yaml) - * **dedicated-network-profiles 0.2.0-alpha.1** - [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.1/code/API_definitions/dedicated-network-profiles.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network-profiles.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network-profiles.yaml) - * **dedicated-network 0.2.0-alpha.1** - [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.1/code/API_definitions/dedicated-network.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network.yaml) - * **dedicated-network-areas 0.1.0-alpha.1** - [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.1/code/API_definitions/dedicated-network-areas.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network-areas.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.1/code/API_definitions/dedicated-network-areas.yaml) +* Pre-release: [r2.2](https://github.com/camaraproject/DedicatedNetworks/releases/tag/r2.2) (release candidate) + * **dedicated-network-accesses 0.2.0-rc.1** + [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network-accesses.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network-accesses.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network-accesses.yaml) + * **dedicated-network-profiles 0.2.0-rc.1** + [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network-profiles.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network-profiles.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network-profiles.yaml) + * **dedicated-network 0.2.0-rc.1** + [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network.yaml) + * **dedicated-network-areas 0.1.0-rc.1** + [[YAML]](https://github.com/camaraproject/DedicatedNetworks/blob/r2.2/code/API_definitions/dedicated-network-areas.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network-areas.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/DedicatedNetworks/r2.2/code/API_definitions/dedicated-network-areas.yaml) _The above section is automatically synchronized by CAMARA project-administration._