From e93bfe20eb3f68c103d0f6e1c3a6da326df29482 Mon Sep 17 00:00:00 2001 From: chinaunicom-xiaodr Date: Mon, 25 Aug 2025 16:12:44 +0800 Subject: [PATCH 01/10] update something in M4 review --- CHANGELOG.md | 26 +++++++++++++++++++ README.md | 6 ++++- .../network-slice-booking.yaml | 4 +-- ...etwork-slice-booking-createSession.feature | 6 ++--- ...etwork-slice-booking-deleteSession.feature | 6 ++--- .../network-slice-booking-getSession.feature | 6 ++--- ...k-slice-booking-API-Readiness-Checklist.md | 8 +++--- 7 files changed, 46 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4434d16..a576578 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Table of Contents - [r1.1](#r1.1) +- [r1.2](#r1.2) **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.** @@ -13,6 +14,31 @@ 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 +# r1.2 +## Release note: +This release contains the definition and documentation of + +- network-slice-booking v0.1.0 + +The API definition(s) are based on + +- Commonalities v0.6.0 +- Identity and Consent Management v0.4.0 +## network-slice-booking v0.1.0 + +**network-slice-booking v0.1.0 is first public release version of the network-slice-booking API** + +### Added +* Upload Network Slice Booking API initial documentation in [#4](https://github.com/camaraproject/NetworkSliceBooking/pull/4) +* Add Network Slice Booking API user story in [#13](https://github.com/camaraproject/NetworkSliceBooking/pull/13) +* Add API design document in [#20](https://github.com/camaraproject/NetworkSliceBooking/pull/20) +* Initial API yaml including Network Slice Booking API in [#32](https://github.com/camaraproject/NetworkSliceBooking/pull/32) +* Add API checklist in [#48](https://github.com/camaraproject/NetworkSliceBooking/pull/48) +* Update API yaml, modify and format the status codes 200, 204, 404, 409 aligment with commonalities in [#50](https://github.com/camaraproject/NetworkSliceBooking/pull/50) +* Update API yaml, remove AUTHENTICATION_REQUIRED error code in [#55](https://github.com/camaraproject/NetworkSliceBooking/pull/55) +* Add the test file of Network Slice Booking API and update the file of checklist in [#57](https://github.com/camaraproject/NetworkSliceBooking/pull/57) + + # r1.1 ## Release note: This release contains the definition and documentation of diff --git a/README.md b/README.md index 5fc8468..4327284 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,11 @@ Sandbox API Repository to describe, develop, document, and test the NetworkSlice ## Release Information -Pre-releases of this sub project are available in https://github.com/camaraproject/NetworkSliceBooking/releases +* `NEW`:Public release r1.2 with version 0.1.0 is available here(https://github.com/camaraproject/NetworkSliceBooking/releases).[yaml] +(https://github.com/XunliYang/NetworkSliceBooking/blob/main/code/API_definitions/network-slice-booking.yaml) +[View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml&nocors) +[View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml) + diff --git a/code/API_definitions/network-slice-booking.yaml b/code/API_definitions/network-slice-booking.yaml index 7278ac0..f5dd13b 100644 --- a/code/API_definitions/network-slice-booking.yaml +++ b/code/API_definitions/network-slice-booking.yaml @@ -41,7 +41,7 @@ info: As a specific rule, error `501 - NOT_IMPLEMENTED` can be only a possible error response if it is explicitly documented in the API. - version: 0.1.0-rc.1 + version: 0.1.0 x-camara-commonalities: 0.6 license: name: Apache 2.0 @@ -50,7 +50,7 @@ externalDocs: description: Project documentation at CAMARA url: https://github.com/camaraproject/NetworkSliceBooking servers: - - url: "{apiRoot}/network-slice-booking/v0.1rc1" + - url: "{apiRoot}/network-slice-booking/v0.1" variables: apiRoot: default: http://localhost:9100 diff --git a/code/Test_definitions/network-slice-booking-createSession.feature b/code/Test_definitions/network-slice-booking-createSession.feature index d1077fe..85869b7 100644 --- a/code/Test_definitions/network-slice-booking-createSession.feature +++ b/code/Test_definitions/network-slice-booking-createSession.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Network Slice Booking API v0.1.0-rc.1 - Operation createSession +Feature: CAMARA Network Slice Booking API v0.1.0 - Operation createSession # Input to be provided by the implementation to the tester # @@ -14,11 +14,11 @@ Feature: CAMARA Network Slice Booking API v0.1.0-rc.1 - Operation createSession # * An Area outside the supported area # * A combination of request parameters including service area, start time, and end time, configuration information of network slicing # - # References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0-rc.1 + # References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0 Background: Common createSession setup Given an environment at "apiRoot" - And the resource "/network-slice-booking/v0.1rc1/sessions" + And the resource "/network-slice-booking/v0.1/sessions" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/code/Test_definitions/network-slice-booking-deleteSession.feature b/code/Test_definitions/network-slice-booking-deleteSession.feature index b6c9383..ac0401b 100644 --- a/code/Test_definitions/network-slice-booking-deleteSession.feature +++ b/code/Test_definitions/network-slice-booking-deleteSession.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Network Slice Booking API v0.1.0-rc.1 - Operation deleteSession +Feature: CAMARA Network Slice Booking API v0.1.0 - Operation deleteSession # Input to be provided by the implementation to the tester # @@ -7,11 +7,11 @@ Feature: CAMARA Network Slice Booking API v0.1.0-rc.1 - Operation deleteSession # # Testing assets: # * The sessionId of an existing session. - # * References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0-rc.1 + # * References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0 Background: Common deleteSession setup Given an environment at "apiRoot" - And the resource "/network-slice-booking/v0.1rc1/sessions/{sessionId}" + And the resource "/network-slice-booking/v0.1/sessions/{sessionId}" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/code/Test_definitions/network-slice-booking-getSession.feature b/code/Test_definitions/network-slice-booking-getSession.feature index a325192..3df3d51 100644 --- a/code/Test_definitions/network-slice-booking-getSession.feature +++ b/code/Test_definitions/network-slice-booking-getSession.feature @@ -1,4 +1,4 @@ -Feature: CAMARA Network Slice Booking API v0.1.0-rc.1 - Operation getSession +Feature: CAMARA Network Slice Booking API v0.1.0 - Operation getSession # Input to be provided by the implementation to the tester # @@ -7,11 +7,11 @@ Feature: CAMARA Network Slice Booking API v0.1.0-rc.1 - Operation getSession # # Testing assets: # * The sessionId of an existing session. - # * References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0-rc.1 + # * References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0 Background: Common getSession setup Given an environment at "apiRoot" - And the resource "/network-slice-booking/v0.1rc1/sessions/{sessionId}" + And the resource "/network-slice-booking/v0.1/sessions/{sessionId}" And the header "Content-Type" is set to "application/json" And the header "Authorization" is set to a valid access token And the header "x-correlator" complies with the schema at "#/components/schemas/XCorrelator" diff --git a/documentation/API_documentation/network-slice-booking-API-Readiness-Checklist.md b/documentation/API_documentation/network-slice-booking-API-Readiness-Checklist.md index 1b6d5d9..257aaa5 100644 --- a/documentation/API_documentation/network-slice-booking-API-Readiness-Checklist.md +++ b/documentation/API_documentation/network-slice-booking-API-Readiness-Checklist.md @@ -1,13 +1,13 @@ # API Readiness Checklist -Checklist for network-slicing-book v0.1.0-rc.1 in r1.1 +Checklist for network-slicing-book v0.1.0 in r1.2 | Nr | API release assets | alpha | release-candidate | initial
public | stable
public | Status | Reference information | |----|----------------------------------------------|:-----:|:-----------------:|:-------:|:------:|:----:|:-------------------------------------------------------------------------------------------:| | 1 | API definition | M | M | M | M | Y | [link](/code/API_definitions/network-slice-booking.yaml) | -| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/Commonalities/releases/tag/r3.2) | -| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.2](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.2) | -| 4 | API versioning convention applied | M | M | M | M | Y | v0.1.0-rc.1 | +| 2 | Design guidelines from Commonalities applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/Commonalities/releases/tag/r3.3) | +| 3 | Guidelines from ICM applied | O | M | M | M | Y | [r3.3](https://github.com/camaraproject/IdentityAndConsentManagement/releases/tag/r3.3) | +| 4 | API versioning convention applied | M | M | M | M | Y | v0.1.0 | | 5 | API documentation | M | M | M | M | Y | Embed documentation into API spec - [link](/code/API_definitions/network-slice-booking.yaml) | | 6 | User stories | O | O | O | M | Y | [UserStory for Network Slicing Booking](/documentation/API_documentation/NSB_User_Story.md) | | 7 | Basic API test cases & documentation | O | M | M | M | Y | [link](/code/Test_definitions) | From b4fc8c9e3507963320181232660fd93e999c024f Mon Sep 17 00:00:00 2001 From: XunliYang Date: Mon, 25 Aug 2025 17:36:47 +0800 Subject: [PATCH 02/10] Add r1.2 changelog --- CHANGELOG.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a576578..b711490 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,16 +28,14 @@ The API definition(s) are based on **network-slice-booking v0.1.0 is first public release version of the network-slice-booking API** +### Changed +* Fix megalinter issues in [#71](https://github.com/camaraproject/NetworkSliceBooking/pull/71) +* Fix trailing-spaces issues in [#73](https://github.com/camaraproject/NetworkSliceBooking/pull/73) +* Align the error name to Generic429 and change mandatory description for date-time string format in [#75](https://github.com/camaraproject/NetworkSliceBooking/issues/75) ### Added -* Upload Network Slice Booking API initial documentation in [#4](https://github.com/camaraproject/NetworkSliceBooking/pull/4) -* Add Network Slice Booking API user story in [#13](https://github.com/camaraproject/NetworkSliceBooking/pull/13) -* Add API design document in [#20](https://github.com/camaraproject/NetworkSliceBooking/pull/20) -* Initial API yaml including Network Slice Booking API in [#32](https://github.com/camaraproject/NetworkSliceBooking/pull/32) -* Add API checklist in [#48](https://github.com/camaraproject/NetworkSliceBooking/pull/48) -* Update API yaml, modify and format the status codes 200, 204, 404, 409 aligment with commonalities in [#50](https://github.com/camaraproject/NetworkSliceBooking/pull/50) -* Update API yaml, remove AUTHENTICATION_REQUIRED error code in [#55](https://github.com/camaraproject/NetworkSliceBooking/pull/55) -* Add the test file of Network Slice Booking API and update the file of checklist in [#57](https://github.com/camaraproject/NetworkSliceBooking/pull/57) - +* Add centralized linting workflows to ensure code quality and API specification compliance in [#69](https://github.com/camaraproject/NetworkSliceBooking/pull/69) +* Add text description for duration format fields in [#75](https://github.com/camaraproject/NetworkSliceBooking/issues/75) +**Full Changelog**: https://github.com/camaraproject/NetworkSliceBooking/commits/r1.1 # r1.1 ## Release note: @@ -66,3 +64,5 @@ The API definition(s) are based on * Update API yaml, modify and format the status codes 200, 204, 404, 409 aligment with commonalities in [#50](https://github.com/camaraproject/NetworkSliceBooking/pull/50) * Update API yaml, remove AUTHENTICATION_REQUIRED error code in [#55](https://github.com/camaraproject/NetworkSliceBooking/pull/55) * Add the test file of Network Slice Booking API and update the file of checklist in [#57](https://github.com/camaraproject/NetworkSliceBooking/pull/57) +* Align the API definition with Commonalities r3.2 and ICM r3.2 in [#59](https://github.com/camaraproject/NetworkSliceBooking/pull/59) +**Full Changelog**: https://github.com/camaraproject/NetworkSliceBooking/commits/r1.1 From 6f9910cffdb404621216482838761af68dc3abfa Mon Sep 17 00:00:00 2001 From: XunliYang Date: Tue, 26 Aug 2025 11:21:20 +0800 Subject: [PATCH 03/10] Modify urls for r1.2 --- CHANGELOG.md | 2 +- README.md | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b711490..38a5acb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,7 +35,7 @@ The API definition(s) are based on ### Added * Add centralized linting workflows to ensure code quality and API specification compliance in [#69](https://github.com/camaraproject/NetworkSliceBooking/pull/69) * Add text description for duration format fields in [#75](https://github.com/camaraproject/NetworkSliceBooking/issues/75) -**Full Changelog**: https://github.com/camaraproject/NetworkSliceBooking/commits/r1.1 +**Full Changelog**: https://github.com/camaraproject/NetworkSliceBooking/commits/r1.2 # r1.1 ## Release note: diff --git a/README.md b/README.md index 4327284..4a227e0 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ Sandbox API Repository to describe, develop, document, and test the NetworkSlice ## Release Information -* `NEW`:Public release r1.2 with version 0.1.0 is available here(https://github.com/camaraproject/NetworkSliceBooking/releases).[yaml] -(https://github.com/XunliYang/NetworkSliceBooking/blob/main/code/API_definitions/network-slice-booking.yaml) -[View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml&nocors) -[View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml) +- `NEW`:Public release [r1.2](https://github.com/camaraproject/NetworkSliceBooking/releases/tag/r1.2) with network-slice-booking v0.1.0 is now available: + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml&nocors) + - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/code/API_definitions/network-slice-booking.yaml) From 5c2e78e651cef166d1fe22341cfdc21df1cf5749 Mon Sep 17 00:00:00 2001 From: XunliYang Date: Mon, 15 Sep 2025 15:32:57 +0800 Subject: [PATCH 04/10] Add x-correlator in request parameters and response headers --- code/API_definitions/network-slice-booking.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/code/API_definitions/network-slice-booking.yaml b/code/API_definitions/network-slice-booking.yaml index 8790b69..1f5041f 100644 --- a/code/API_definitions/network-slice-booking.yaml +++ b/code/API_definitions/network-slice-booking.yaml @@ -74,6 +74,8 @@ paths: security: - openId: - network-slice-booking:sessions:create + parameters: + - $ref: "#/components/parameters/x-correlator" requestBody: description: Parameters to create a new session content: @@ -90,6 +92,9 @@ paths: responses: "201": description: Session created successfully + headers: + x-correlator: + $ref: "#/components/headers/x-correlator" content: application/json: schema: @@ -135,9 +140,13 @@ paths: required: true schema: $ref: "#/components/schemas/SessionId" + - $ref: "#/components/parameters/x-correlator" responses: "204": description: Session deleted + headers: + x-correlator: + $ref: "#/components/headers/x-correlator" "400": $ref: "#/components/responses/Generic400" "401": @@ -170,9 +179,13 @@ paths: required: true schema: $ref: "#/components/schemas/SessionId" + - $ref: "#/components/parameters/x-correlator" responses: "200": description: Contains information about active session + headers: + x-correlator: + $ref: "#/components/headers/x-correlator" content: application/json: schema: From a1b38accf21215f161884e274aac25825569d66b Mon Sep 17 00:00:00 2001 From: XunliYang Date: Mon, 15 Sep 2025 15:42:37 +0800 Subject: [PATCH 05/10] Correct the link to API_Design.md --- code/API_definitions/network-slice-booking.yaml | 2 +- ...ooking API Design.md => Network_Slice_Booking_API_Design.md} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename documentation/API_documentation/{Network Slice Booking API Design.md => Network_Slice_Booking_API_Design.md} (100%) diff --git a/code/API_definitions/network-slice-booking.yaml b/code/API_definitions/network-slice-booking.yaml index 1f5041f..b2e82f3 100644 --- a/code/API_definitions/network-slice-booking.yaml +++ b/code/API_definitions/network-slice-booking.yaml @@ -3,7 +3,7 @@ info: title: Network Slice Booking description: | The Network Slice Booking (NSB) API provides programmable interface for developers to reserve a slice resource of a selected area within a period, and manage device access control as needed. - For specific details, please refer to [Network Slice Booking API Design.md](/documentation/API_documentation/Network_Slice_Booking_API_Design.md). + For specific details, please refer to [Network Slice Booking API Design.md](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/documentation/API_documentation/Network_Slice_Booking_API_Design.md). # Introduction diff --git a/documentation/API_documentation/Network Slice Booking API Design.md b/documentation/API_documentation/Network_Slice_Booking_API_Design.md similarity index 100% rename from documentation/API_documentation/Network Slice Booking API Design.md rename to documentation/API_documentation/Network_Slice_Booking_API_Design.md From bec2b658e6c42ea14b84d59dffac130cb508a4d0 Mon Sep 17 00:00:00 2001 From: XunliYang Date: Mon, 15 Sep 2025 16:46:28 +0800 Subject: [PATCH 06/10] Rename Generic422 --- code/API_definitions/network-slice-booking.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/code/API_definitions/network-slice-booking.yaml b/code/API_definitions/network-slice-booking.yaml index b2e82f3..ad0b2b9 100644 --- a/code/API_definitions/network-slice-booking.yaml +++ b/code/API_definitions/network-slice-booking.yaml @@ -113,7 +113,7 @@ paths: "410": $ref: "#/components/responses/Generic410" "422": - $ref: "#/components/responses/Generic422" + $ref: "#/components/responses/NetworkSliceBooking422" "429": $ref: "#/components/responses/Generic429" @@ -626,7 +626,7 @@ components: status: 410 code: GONE message: Access to the target resource is no longer available. - Generic422: + NetworkSliceBooking422: description: Unprocessable Content headers: x-correlator: From 5fbcbb14eac167db49b80716c9f26cd8b37e5d7c Mon Sep 17 00:00:00 2001 From: XunliYang Date: Mon, 15 Sep 2025 17:17:24 +0800 Subject: [PATCH 07/10] Remove 410 GONE --- .../network-slice-booking.yaml | 27 ------------------- ...etwork-slice-booking-createSession.feature | 11 -------- 2 files changed, 38 deletions(-) diff --git a/code/API_definitions/network-slice-booking.yaml b/code/API_definitions/network-slice-booking.yaml index ad0b2b9..aa3d589 100644 --- a/code/API_definitions/network-slice-booking.yaml +++ b/code/API_definitions/network-slice-booking.yaml @@ -110,8 +110,6 @@ paths: $ref: "#/components/responses/Generic401" "403": $ref: "#/components/responses/Generic403" - "410": - $ref: "#/components/responses/Generic410" "422": $ref: "#/components/responses/NetworkSliceBooking422" "429": @@ -601,31 +599,6 @@ components: status: 404 code: NOT_FOUND message: The specified resource is not found. - Generic410: - description: Gone - headers: - x-correlator: - $ref: "#/components/headers/x-correlator" - content: - application/json: - schema: - allOf: - - $ref: "#/components/schemas/ErrorInfo" - - type: object - properties: - status: - enum: - - 410 - code: - enum: - - GONE - examples: - GENERIC_410_GONE: - description: Use in notifications flow to allow API Consumer to indicate that its callback is no longer available - value: - status: 410 - code: GONE - message: Access to the target resource is no longer available. NetworkSliceBooking422: description: Unprocessable Content headers: diff --git a/code/Test_definitions/network-slice-booking-createSession.feature b/code/Test_definitions/network-slice-booking-createSession.feature index 85869b7..46bcd8d 100644 --- a/code/Test_definitions/network-slice-booking-createSession.feature +++ b/code/Test_definitions/network-slice-booking-createSession.feature @@ -83,17 +83,6 @@ Feature: CAMARA Network Slice Booking API v0.1.0 - Operation createSession And the response property "$.code" is "PERMISSION_DENIED" And the response property "$.message" contains a user friendly text - @network_slice_booking_createSession_06_resource_exhaustion_scenario - Scenario: Error response for resource exhaustion - Given the right request body property argument - When the request "createSession" is sent - Then the response status code is 410 - And the response header "x-correlator" has same value as the request header "x-correlator" - And the response header "Content-Type" is "application/json" - And the response property "$.status" is 410 - And the response property "$.code" is "GONE" - And the response property "$.message" is "Access to the target resource is no longer available." - @network_slice_booking_createSession_07_area_not_support_fail_scenario Scenario: Common validations for fail scenario of area not supported Given starttime, endtime, the request body property "$.serviceArea" is set to the service area of not supported and the configuration of information of network slicing From 01c92578b361827767104c9ea489bc611d1c34f9 Mon Sep 17 00:00:00 2001 From: XunliYang Date: Mon, 15 Sep 2025 17:36:00 +0800 Subject: [PATCH 08/10] Correct field format and naming conventions --- .../network-slice-booking.yaml | 32 +++++++++---------- ...etwork-slice-booking-createSession.feature | 2 +- ...etwork-slice-booking-deleteSession.feature | 4 +-- .../network-slice-booking-getSession.feature | 4 +-- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/code/API_definitions/network-slice-booking.yaml b/code/API_definitions/network-slice-booking.yaml index aa3d589..083e534 100644 --- a/code/API_definitions/network-slice-booking.yaml +++ b/code/API_definitions/network-slice-booking.yaml @@ -673,16 +673,16 @@ components: maxNumOfDevices: 5 downStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps upStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps downStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds upStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds RETRIEVAL_POLYGON: value: serviceTime: @@ -703,16 +703,16 @@ components: maxNumOfDevices: 5 downStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps upStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps downStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds upStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds RESPONSE_CIRCLE: value: serviceTime: @@ -728,16 +728,16 @@ components: maxNumOfDevices: 5 downStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps upStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps downStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds upStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds sessionId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" RESPONSE_POLYGON: value: @@ -759,14 +759,14 @@ components: maxNumOfDevices: 5 downStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps upStreamRatePerDevice: value: 10 - unit: "bps" + unit: bps downStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds upStreamDelayBudget: value: 12 - unit: "Milliseconds" + unit: Milliseconds sessionId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" diff --git a/code/Test_definitions/network-slice-booking-createSession.feature b/code/Test_definitions/network-slice-booking-createSession.feature index 46bcd8d..1f61c02 100644 --- a/code/Test_definitions/network-slice-booking-createSession.feature +++ b/code/Test_definitions/network-slice-booking-createSession.feature @@ -14,7 +14,7 @@ Feature: CAMARA Network Slice Booking API v0.1.0 - Operation createSession # * An Area outside the supported area # * A combination of request parameters including service area, start time, and end time, configuration information of network slicing # - # References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0 + # References to OAS spec schemas refer to schemas specified in network-slice-booking.yaml, version 0.1.0 Background: Common createSession setup Given an environment at "apiRoot" diff --git a/code/Test_definitions/network-slice-booking-deleteSession.feature b/code/Test_definitions/network-slice-booking-deleteSession.feature index ac0401b..cc94b01 100644 --- a/code/Test_definitions/network-slice-booking-deleteSession.feature +++ b/code/Test_definitions/network-slice-booking-deleteSession.feature @@ -7,7 +7,7 @@ Feature: CAMARA Network Slice Booking API v0.1.0 - Operation deleteSession # # Testing assets: # * The sessionId of an existing session. - # * References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0 + # * References to OAS spec schemas refer to schemas specified in network-slice-booking.yaml, version 0.1.0 Background: Common deleteSession setup Given an environment at "apiRoot" @@ -47,7 +47,7 @@ Feature: CAMARA Network Slice Booking API v0.1.0 - Operation deleteSession And the response header "Content-Type" is "application/json" And the response header "x-correlator" has same value as the request header "x-correlator" And the response property "$.status" is 400 - And the response property "$.code" is "INVALID_ARGUMENT" + And the response property "$.code" is "OUT_OF_RANGE" And the response property "$.message" is "Client specified an invalid range." @network_slice_booking_deleteSession_04_missing_authorization_scenario diff --git a/code/Test_definitions/network-slice-booking-getSession.feature b/code/Test_definitions/network-slice-booking-getSession.feature index 3df3d51..4faf176 100644 --- a/code/Test_definitions/network-slice-booking-getSession.feature +++ b/code/Test_definitions/network-slice-booking-getSession.feature @@ -7,7 +7,7 @@ Feature: CAMARA Network Slice Booking API v0.1.0 - Operation getSession # # Testing assets: # * The sessionId of an existing session. - # * References to OAS spec schemas refer to schemas specifies in network-slice-booking.yaml, version 0.1.0 + # * References to OAS spec schemas refer to schemas specified in network-slice-booking.yaml, version 0.1.0 Background: Common getSession setup Given an environment at "apiRoot" @@ -50,7 +50,7 @@ Feature: CAMARA Network Slice Booking API v0.1.0 - Operation getSession And the response header "Content-Type" is "application/json" And the response header "x-correlator" has same value as the request header "x-correlator" And the response property "$.status" is 400 - And the response property "$.code" is "INVALID_ARGUMENT" + And the response property "$.code" is "OUT_OF_RANGE" And the response property "$.message" is "Client specified an invalid range." @network_slice_booking_getSession_04_missing_authorization_scenario From f4eb328420278dd2a7b88920c979f2b456868b44 Mon Sep 17 00:00:00 2001 From: xiaodr Date: Tue, 16 Sep 2025 12:58:14 +0800 Subject: [PATCH 09/10] update readme file according to M4 Review --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4a227e0..c197c4f 100644 --- a/README.md +++ b/README.md @@ -23,14 +23,14 @@ Sandbox API Repository to describe, develop, document, and test the NetworkSlice ## Release Information - `NEW`:Public release [r1.2](https://github.com/camaraproject/NetworkSliceBooking/releases/tag/r1.2) with network-slice-booking v0.1.0 is now available: - - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/code/API_definitions/NetworkSliceBooking.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.2/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/r1.2/code/API_definitions/network-slice-booking.yaml) - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/code/API_definitions/network-slice-booking.yaml) - - - + +The latest public release is available here: https://github.com/camaraproject/NetworkSliceBooking/releases/latest For changes see [CHANGELOG.md](https://github.com/camaraproject/NetworkSliceBooking/blob/main/CHANGELOG.md) + ## Contributing * Meetings are held virtually From 718138995e3c91a1204df01ea2f4e4d55485b5c0 Mon Sep 17 00:00:00 2001 From: XunliYang Date: Tue, 16 Sep 2025 14:45:27 +0800 Subject: [PATCH 10/10] Update CHANGELOG file --- CHANGELOG.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 38a5acb..802f3fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,8 +1,8 @@ # Changelog Network Slice Booking ## Table of Contents -- [r1.1](#r1.1) - [r1.2](#r1.2) +- [r1.1](#r1.1) **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.** @@ -15,7 +15,7 @@ The below sections record the changes for each API version in each release as fo * for a public release, the consolidated changes since the previous public release # r1.2 -## Release note: +## Release Notes This release contains the definition and documentation of - network-slice-booking v0.1.0 @@ -28,17 +28,20 @@ The API definition(s) are based on **network-slice-booking v0.1.0 is first public release 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/r1.2/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/r1.2/code/API_definitions/network-slice-booking.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.2/code/API_definitions/network-slice-booking.yaml) ### Changed -* Fix megalinter issues in [#71](https://github.com/camaraproject/NetworkSliceBooking/pull/71) -* Fix trailing-spaces issues in [#73](https://github.com/camaraproject/NetworkSliceBooking/pull/73) * Align the error name to Generic429 and change mandatory description for date-time string format in [#75](https://github.com/camaraproject/NetworkSliceBooking/issues/75) ### Added * Add centralized linting workflows to ensure code quality and API specification compliance in [#69](https://github.com/camaraproject/NetworkSliceBooking/pull/69) * Add text description for duration format fields in [#75](https://github.com/camaraproject/NetworkSliceBooking/issues/75) + **Full Changelog**: https://github.com/camaraproject/NetworkSliceBooking/commits/r1.2 # r1.1 -## Release note: +## Release Notes This release contains the definition and documentation of - network-slice-booking v0.1.0-rc.1 @@ -52,9 +55,9 @@ The API definition(s) are based on **network-slice-booking v0.1.0-rc.1 is first pre-release 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/r1.1/code/API_definitions/NetworkSliceBooking.yaml&nocors) - - [View it on Swagger Editor](https://camaraproject.github.io/swagger-ui/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.1/code/API_definitions/NetworkSliceBooking.yaml) - - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.1/code/API_definitions/NetworkSliceBooking.yaml) + - [View it on ReDoc](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/camaraproject/NetworkSliceBooking/r1.1/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/r1.1/code/API_definitions/network-slice-booking.yaml) + - OpenAPI [YAML spec file](https://github.com/camaraproject/NetworkSliceBooking/blob/r1.1/code/API_definitions/network-slice-booking.yaml) ### Added * Upload Network Slice Booking API initial documentation in [#4](https://github.com/camaraproject/NetworkSliceBooking/pull/4) * Add Network Slice Booking API user story in [#13](https://github.com/camaraproject/NetworkSliceBooking/pull/13) @@ -65,4 +68,5 @@ The API definition(s) are based on * Update API yaml, remove AUTHENTICATION_REQUIRED error code in [#55](https://github.com/camaraproject/NetworkSliceBooking/pull/55) * Add the test file of Network Slice Booking API and update the file of checklist in [#57](https://github.com/camaraproject/NetworkSliceBooking/pull/57) * Align the API definition with Commonalities r3.2 and ICM r3.2 in [#59](https://github.com/camaraproject/NetworkSliceBooking/pull/59) + **Full Changelog**: https://github.com/camaraproject/NetworkSliceBooking/commits/r1.1