diff --git a/CHANGELOG/CHANGELOG-r2.md b/CHANGELOG/CHANGELOG-r2.md index 95243bd..661d50d 100644 --- a/CHANGELOG/CHANGELOG-r2.md +++ b/CHANGELOG/CHANGELOG-r2.md @@ -2,6 +2,7 @@ ## Table of Contents +- **[r2.3](#r23)** - [r2.2](#r22) @@ -14,6 +15,103 @@ 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 public release contains the definition and documentation of +* network-slice-booking 0.2.0 +* network-slice-assignment 0.1.0 + +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 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. + +
+Candidate changes (auto-generated from merged PRs) + +## What's Changed +* Network slice assignment v2 by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/87 +* Add the network-slice-assignment API user story by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/88 +* Reset API version in main branch to wip by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/90 +* [bulk] Sync Release Information section (2025-12-12-001) by @hdamker-bot in https://github.com/camaraproject/NetworkSliceBooking/pull/91 +* Split NetworkSliceBooking422-SERVICE_NOT_APPLICABLE into SERVICE_AREA_NOT_SUPPORTED and RESOURCES_INSUFFICIENT by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/92 +* Modify network-slice-assignment API Path and Feature Files by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/96 +* Update and align with CAMARA Commonalities 0.7 by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/98 +* [bulk] Add release-plan.yaml (2026-02-23-001) by @hdamker-bot in https://github.com/camaraproject/NetworkSliceBooking/pull/99 +* Release r2.1 with NSB v0.2.0-rc.1 and NSA v0.1.0-rc.1 by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/93 +* update release-plan by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/100 +* Reset API and test code version information in main branch to wip by @hdamker in https://github.com/camaraproject/NetworkSliceBooking/pull/103 +* [bulk] Enable release automation process (2026-03-12-001) by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkSliceBooking/pull/104 +* [bulk] Enable release automation and validation (2026-04-10-001) by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkSliceBooking/pull/105 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkSliceBooking/pull/106 +* Fix questions in commonalities r4.2 by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/108 +* Update Spring26 M4 release plan to public-release by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/110 +* Sync common files from Commonalities r4.2 by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkSliceBooking/pull/111 +* Modify r2.2 release plan from public back to release-candidate by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/114 +* Update API definitions with corrected defaults and schema constraints-align with commonalities r4.2 by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/116 +* [bulk] Update release-automation + validation callers by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkSliceBooking/pull/118 +* Fix validation issues: Adopt Commonalities r4.2 $refs for common event schemas by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/120 +* Release Automation: Post-release sync (r2.2) by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkSliceBooking/pull/125 +* Update release-plan to public release by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/127 +* Align with Commonalities r4.3 - Add mandatory templates and fix schemas by @XunliYang in https://github.com/camaraproject/NetworkSliceBooking/pull/130 +* Sync common files from Commonalities r4.3 by @camara-release-automation[bot] in https://github.com/camaraproject/NetworkSliceBooking/pull/132 + +
+ + +## network-slice-booking 0.2.0 + +**network-slice-booking 0.2.0 is the second public version of the Network Slice Booking API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-booking.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-booking.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.3/code/API_definitions/network-slice-booking.yaml) + +### Added + +* Align with Commonalities r4.3 - Add mandatory templates and fix schemas in [#130](https://github.com/camaraproject/NetworkSliceBooking/pull/130) +* Add maxLength requirement applies to all string properties in [#108](https://github.com/camaraproject/NetworkSliceBooking/pull/108) + +### Changed + +* Rename the term "session" to "slice" for clarity in [#87](https://github.com/camaraproject/NetworkSliceBooking/pull/87) +* Split 422 SERVICE_NOT_APPLICABLE error into SERVICE_AREA_NOT_SUPPORTED and RESOURCES_INSUFFICIENT for better problem understanding in [#92](https://github.com/camaraproject/NetworkSliceBooking/pull/92) +* Change the callback request body schema from CloudEvent to ApiNotificationEvent aligning with Commonalities r4.2 in [#108](https://github.com/camaraproject/NetworkSliceBooking/pull/108) +* Update API definitions with corrected defaults and schema constraints aligning with Commonalities r4.2 in [#116](https://github.com/camaraproject/NetworkSliceBooking/pull/116) +* Replace inline CloudEvent + sink-credential schemas and inline area / geometry schemas with $refs into CAMARA_event_common.yaml in [#120](https://github.com/camaraproject/NetworkSliceBooking/pull/120) + +### Removed + +* Remove the local schema definitions for CloudEvent, sink-credential, area and geometry in favor of $refs into CAMARA_event_common.yaml in [#120](https://github.com/camaraproject/NetworkSliceBooking/pull/120) + +## network-slice-assignment 0.1.0 + +**network-slice-assignment 0.1.0 is the initial public version of the Network Slice Assignment API.** + +- API definition **with inline documentation**: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-assignment.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-assignment.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.3/code/API_definitions/network-slice-assignment.yaml) + +### Added + +* Initial public definition of the Network Slice Assignment API, which lets an API consumer manage the devices that use a booked network slice: + * Assign a device to a network slice + * Get the devices assigned to a network slice + * Release a device from a network slice + * Retrieve all network slices for a given device + * Receive a notification when a device assignment changes + +**Full Changelog**: https://github.com/camaraproject/NetworkSliceBooking/compare/r1.2...r2.3 + # r2.2 ## Release Notes diff --git a/README.md b/README.md index 2e34e3e..ffe4233 100644 --- a/README.md +++ b/README.md @@ -29,23 +29,16 @@ Sandbox API Repository to describe, develop, document, and test the NetworkSlice > [!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**. -* The latest public release is [r1.2](https://github.com/camaraproject/NetworkSliceBooking/releases/tag/r1.2), with the following API versions: - * **network-slice-booking 0.1.0** - [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/code/API_definitions/network-slice-booking.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/network-slice-booking.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/network-slice-booking.yaml) +* The latest public release is [r2.3](https://github.com/camaraproject/NetworkSliceBooking/releases/tag/r2.3) (Spring26), with the following API versions: + * **network-slice-booking 0.2.0** + [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.3/code/API_definitions/network-slice-booking.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-booking.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-booking.yaml) + * **network-slice-assignment 0.1.0** + [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.3/code/API_definitions/network-slice-assignment.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-assignment.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.3/code/API_definitions/network-slice-assignment.yaml) * The latest public release is always available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest * Other releases of this repository are available in https://github.com/camaraproject/NetworkSliceBooking/releases * For changes see [CHANGELOG](https://github.com/camaraproject/NetworkSliceBooking/tree/main/CHANGELOG) -### Upcoming Release Preview - -* Pre-release: [r2.2](https://github.com/camaraproject/NetworkSliceBooking/releases/tag/r2.2) (release candidate) - * **network-slice-booking 0.2.0-rc.2** - [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.2/code/API_definitions/network-slice-booking.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.2/code/API_definitions/network-slice-booking.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.2/code/API_definitions/network-slice-booking.yaml) - * **network-slice-assignment 0.1.0-rc.2** - [[YAML]](https://github.com/camaraproject/NetworkSliceBooking/blob/r2.2/code/API_definitions/network-slice-assignment.yaml) [[ReDoc]](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.2/code/API_definitions/network-slice-assignment.yaml&nocors) [[Swagger]](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r2.2/code/API_definitions/network-slice-assignment.yaml) - - _The above section is automatically synchronized by CAMARA project-administration._