Skip to content
Closed
Show file tree
Hide file tree
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
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
Expand All @@ -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
Expand Down
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ Sandbox API Repository to describe, develop, document, and test the NetworkSlice

## Release Information
<!-- Use/uncomment one or multiple the following options -->
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)

<!-- The latest public release is available here: https://github.com/camaraproject/§repo_name§/releases/latest -->
<!-- For changes see [CHANGELOG.md](https://github.com/camaraproject/§repo_name§/blob/main/CHANGELOG.md) -->

Expand Down
34 changes: 4 additions & 30 deletions code/API_definitions/network-slice-booking.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -147,7 +147,7 @@ paths:
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429_requests"
$ref: "#/components/responses/Generic429"

get:
tags:
Expand Down Expand Up @@ -192,7 +192,7 @@ paths:
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429_requests"
$ref: "#/components/responses/Generic429"

components:
securitySchemes:
Expand Down Expand Up @@ -672,32 +672,6 @@ components:
code: TOO_MANY_REQUESTS
message: Rate limit reached.

Generic429_requests:
description: Too Many Requests
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ErrorInfo"
- type: object
properties:
status:
enum:
- 429
code:
enum:
- TOO_MANY_REQUESTS
examples:
GENERIC_429_TOO_MANY_REQUESTS:
description: Access to the API has been temporarily blocked due to rate or spike arrest limits being reached
value:
status: 429
code: TOO_MANY_REQUESTS
message: Rate limit reached.

examples:
RETRIEVAL_CIRCLE:
value:
Expand Down
Original file line number Diff line number Diff line change
@@ -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
#
Expand All @@ -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"
Expand Down
Original file line number Diff line number Diff line change
@@ -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
#
Expand All @@ -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"
Expand Down
Original file line number Diff line number Diff line change
@@ -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
#
Expand All @@ -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"
Expand Down
Original file line number Diff line number Diff line change
@@ -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<br>public | stable<br> 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) |
Expand Down
41 changes: 41 additions & 0 deletions documentation/MeetingMinutes/MOM-2025-07-04.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# CAMARA Network Slice Booking Meeting - MOM-2025-07-04


*Friday, July 4th, 2025*


## Attendees
* Xunli Yang (Huawei)
* Xiao Dongrui (China Unicom)
* Rafal Artych (DT)
* Masaharu Hattori (KDDI)
* Veerat Kulkarni




## Agenda
* Introduce the current progress of API Release and the next plan
* PR#59 discussion - add some developer-friendly API description, make some general terminology adjustments.
* Free discussion
* AOB


## Issues Discussions
* PR#59 discussion
* Add some developer-friendly API description in yaml file.
* Unified the terminology for the defined QoSProfile parameters to align with QoD.
* Ready for the API release-candidate version.
* Free discussion - Business Model for Sclice Booking
* If there is a new infrastructure needs to be spawned up for the specific network slice booking instance, what is the price model for the specific slice?
* Action: This issue can be further discussed in detail after the meeting through email or issue channels.

## Timeline
* Need to follow up with CAMARA release management.
* Merge PR#54, and release API release candidate version r1.1.

## AOB
1. The next call will be on Friday, 18th July, 16:00 CST / 10:00 CET



50 changes: 50 additions & 0 deletions documentation/MeetingMinutes/MOM-2025-07-18.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# CAMARA Network Slice Booking Meeting - MOM-2025-07-018


*Friday, July 18th, 2025*


## Attendees
* Xunli Yang (Huawei)
* Xiao Dongrui (China Unicom)
* Masaharu Hattori (KDDI)
* Surajj Jaggernath (Vodafone)




## Agenda
* Introduce the current progress of API Release and the next plan
* Issue#63 discussion - Naming pattern correction.
* Issue#64 discussion - Supplemental description fields for the API endpoints.
* Issue#65 discussion - Modify the name for schema QosProfile to avoid confusions.
* Free discussion
* AOB


## Issues Discussions
* Issue#63 discussion
* Property and similar names should follow lowerCamelCase naming pattern
* Schema names follow UpperCamelCase naming pattern
* Issue#64 discussion
* Post: Add description field to help the developers understand the endpoint API better.
* Delete: Ideally this should have some explanation about delete usage e.g. what is the effect of deleting the session befor the endtime that is was booked for, etc.
* Get: The description may contain more details about the provided resource information that is returned when calling this end-point.
* Issue#65 discussion
* Modify the name for schema QosProfile to avoid confusions.
* There is already a definition for QosProfile within the API qos-profiles in QualityOnDemand which is different from the definition here (as defined as profile for one device).
* Consider to modify the name for the profile which is specific for NetworkSliceBooking to avoid confusions.
* Action: decided on the name `SliceQosProfile`.
* Free discussion
* The plan for the API of managing device access.
* Plan to release this part of API in the next release(Spring26).

## Timeline
* Need to follow up with CAMARA release management.
* Merge PR#54, and release API release candidate version r1.1.

## AOB
1. The next call will be on Friday, 1st Aug, 16:00 CST / 10:00 CET