Skip to content

Network slice assignment v2 #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chinaunicomyangfan merged 14 commits into from
Dec 3, 2025
Merged

Network slice assignment v2 #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
46d9e94
Add Meeting minutes MOM-2025-09-26
XunliYang Sep 28, 2025
3824ea6
Merge branch 'main' of https://github.com/XunliYang/NetworkSliceBooking
XunliYang Oct 17, 2025
fdd176c
Add network-slice-assignment API
XunliYang Oct 23, 2025
93c3954
Add cloud-event notification
XunliYang Oct 23, 2025
44e0057
modify as the v2
XunliYang Nov 6, 2025
39329a8
Modify the term session to slice, make it clearer for specifing creat…
XunliYang Nov 13, 2025
32f22fe
Modify device and use sliceId
XunliYang Nov 13, 2025
15ae580
Modify statusInfo of assignment and release
XunliYang Nov 14, 2025
3805684
Add 2-legged authentication explanation
XunliYang Nov 14, 2025
de1d88f
Add example of all device identifiers
XunliYang Nov 17, 2025
ae126e9
Add response examples of assignment and release
XunliYang Nov 17, 2025
5df5ec9
Add test files related to network slice assignment
ChinaUnicomXiaoDongrui Nov 18, 2025
0f7353f
Modify the megalinter error
XunliYang Nov 25, 2025
a2cf573
Modify the meglinter error
XunliYang Nov 25, 2025
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
1,520 changes: 1,520 additions & 0 deletions code/API_definitions/network-slice-assignment.yaml
View file
Open in desktop

Large diffs are not rendered by default.

445 changes: 386 additions & 59 deletions code/API_definitions/network-slice-booking.yaml
View file
Open in desktop

Large diffs are not rendered by default.

143 changes: 143 additions & 0 deletions code/Test_definitions/network-slice-assignment-assign.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
Feature: CAMARA Network Slice Assignment API v0.1.0 - Operation assign

# Input to be provided by the implementation to the tester
#
# Implementation indications:
# * apiRoot: API root of the server URL
# * List of device identifier types which are not supported, among: phoneNumber, ipv4Address, ipv6Address.
# * For this version, CAMARA does not allow the use of networkAccessIdentifier, so it is considered by default as not supported.
#
# References to OAS spec schemas refer to schemas specified in network-slice-assignment.yaml, version 0.1.0

Background: Common assignSlice setup
Given an environment at "apiRoot"
And the resource "/network-slice-assignment/v0.1/slices/devices/assign"
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"

# Success scenarios

@network_slice_booking_assignSlice_01_generic_success_scenario
Scenario: Common validations for any success scenario
Given a valid testing device supported by the service and slice id have already been allocated
When the request "assignSlice" is sent
Then the response status code is 201
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 body complies with the OAS schema at "/components/schemas/AssignmentInfo"
And the response property "$.sliceId" is a character string
And the response property "$.device" exists only if provided in the request body and with the same value
And the assigned status include in "SUCCESS" and "FAILURE"
And the corresponding status prompt information

@network_slice_booking_assignSlice_02_invalid_argument_scenario
Scenario: Error response for invalid argument in request body
Given the request body property argument is invalid, such as illegal character and format error
When the request "assignSlice" is sent
Then the response status code is 400
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 "$.message" is "Client specified an invalid argument, request body or query param."

@network_slice_booking_assignSlice_03_out_of_range_scenario
Scenario: Error responses where the parameters in the request body are out of range
Given the request body property argument are out of range, for example maxNumOfDevices is a negative integer
When the request "assignSlice" is sent
Then the response status code is 400
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 "OUT_OF_RANGE"
And the response property "$.message" is "Client specified an invalid range."

@network_slice_booking_assignSlice_04_missing_authorization_scenario
Scenario: Error response for no header "Authorization"
Given the header "Authorization" is not sent
And the request body is set to a valid request body
When the request "assignSlice" is sent
Then the response status code is 401
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 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text

@network_slice_booking_assignSlice_05_missing_access_token_scope_scenario
Scenario: Missing access token scope
Given the header "Authorization" is set to an access token that does not include scope network-slice-booking:slices:assign
When the request "assignSlice" is sent
Then the response status code is 403
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 403
And the response property "$.code" is "PERMISSION_DENIED"
And the response property "$.message" contains a user friendly text

@network_slice_booking_assignSlice_06_server_resource_not_found_scenario
Scenario: Error response for not found server resouce
Given an correct format and existing network slice id
When the request "assignSlice" is sent
Then the response status code is 404
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 404
And the response property "$.code" is "NOT_FOUND"
And the response property "$.message" contains a user friendly text

@network_slice_booking_assignSlice_07_business_resource_not_found_scenario
Scenario: Error response for not found bussiness resouce
Given an correct format and not existing network slice id
When the request "assignSlice" is sent
Then the response status code is 404
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 404
And the response property "$.code" is "IDENTIFIER_NOT_FOUND"
And the response property "$.message" contains a user friendly text

@network_slice_booking_assignSlice_08_service_not_applicable_scenario
Scenario: Common validations for fail scenario of area not supported
Given the correct slice id is not supported by the service
When the request "assignSlice" is sent
Then the response status code is 422
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 422
And the response property "$.code" is "SERVICE_NOT_APPLICABLE"
And the response property "$.message" is "The service is not available for the provided identifier."

@network_slice_booking_assignSlice_09_inapposite_identifier_scenario
Scenario: Common validations for fail scenario of inapposite identifier
Given inapposite identifier or identifier is lost
When the request "assignSlice" is sent
Then the response status code is 422
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 422
And the response property "$.code" such as "MISSING_IDENTIFIER", "UNSUPPORTED_IDENTIFIER" and "UNNECESSARY_IDENTIFIER"
And the response property "$.message" contains a user friendly text

@network_slice_booking_assignSlice_10_quota_exceeded_scenario
Scenario: Error response for quota exceeded
Given the right request body property argument
When the request "assignSlice" is sent
Then the response status code is 429
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 429
And the response property "$.code" is "QUOTA_EXCEEDED"
And the response property "$.message" is "Out of resource quota."

@network_slice_booking_assignSlice_11_too_many_requests_scenario
Scenario: Error response for too many requests
Given the right request body property argument
When the request "assignSlice" is sent
Then the response status code is 429
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 429
And the response property "$.code" is "TOO_MANY_REQUESTS"
And the response property "$.message" is "Rate limit reached."
150 changes: 150 additions & 0 deletions code/Test_definitions/network-slice-assignment-get.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
Feature: CAMARA Network Slice Assignment API v0.1.0 - Operation get

# Get information about devices assigned to an existing network slice.

# Input to be provided by the implementation to the tester
#
# Implementation indications:
# * apiRoot: API root of the server URL

# Input to be provided by the implementation to the tester
#
# Implementation indications:
# * apiRoot: API root of the server URL
# * List of device identifier types which are not supported, among: phoneNumber, ipv4Address, ipv6Address.
# * For this version, CAMARA does not allow the use of networkAccessIdentifier, so it is considered by default as not supported.
#
# References to OAS spec schemas refer to schemas specified in network-slice-assignment.yaml, version 0.1.0

Background: Common getDevice setup
Given an environment at "apiRoot"
And the resource "/network-slice-assignment/v0.1/slices/devices/get/{sliceId}"
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"
# Properties not explicitly overwritten in the Scenarios can take any values compliant with the schema
And the path parameter "sliceId" is set by default to a existing network slice id

# Success scenarios

@network_slice_booking_getDevice_01_generic_success_scenario
Scenario: Query the bound devices under the slice resouce
Given a slice id of a device that has already been bound
When the request "getDevice" is sent
Then the response status code is 200
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 "$.sliceId" is a character string
And the response property "$.deviceList" is an array format that stores device information under slices
And the response property "$.sliceInfo" is a json format that stores the configuration information of slice resources

@network_slice_booking_getDevice_02_invalid_argument_scenario
Scenario: Error response for invalid argument in request body
Given the request body property argument is invalid, such as illegal character and format error
When the request "getDevice" is sent
Then the response status code is 400
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 "$.message" is "Client specified an invalid argument, request body or query param."

@network_slice_booking_getDevice_03_out_of_range_scenario
Scenario: Error responses where the parameters in the request body are out of range
Given the request body property argument are out of range, for example maxNumOfDevices is a negative integer
When the request "getDevice" is sent
Then the response status code is 400
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 "OUT_OF_RANGE"
And the response property "$.message" is "Client specified an invalid range."

@network_slice_booking_getDevice_04_missing_authorization_scenario
Scenario: Error response for no header "Authorization"
Given the header "Authorization" is not sent
And the request body is set to a valid request body
When the request "getDevice" is sent
Then the response status code is 401
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 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text

@network_slice_booking_getDevice_05_missing_access_token_scope_scenario
Scenario: Missing access token scope
Given the header "Authorization" is set to an access token that does not include scope network-slice-booking:slices:assign
When the request "getDevice" is sent
Then the response status code is 403
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 403
And the response property "$.code" is "PERMISSION_DENIED"
And the response property "$.message" contains a user friendly text

@network_slice_booking_getDevice_06_server_resource_not_found_scenario
Scenario: Error response for not found server resouce
Given an correct format and existing network slice id
When the request "getDevice" is sent
Then the response status code is 404
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 404
And the response property "$.code" is "NOT_FOUND"
And the response property "$.message" contains a user friendly text

@network_slice_booking_getDevice_07_business_resource_not_found_scenario
Scenario: Error response for not found bussiness resouce
Given an correct format and not existing network slice id
When the request "getDevice" is sent
Then the response status code is 404
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 404
And the response property "$.code" is "IDENTIFIER_NOT_FOUND"
And the response property "$.message" contains a user friendly text

@network_slice_booking_getDevice_08_service_not_applicable_scenario
Scenario: Common validations for fail scenario of area not supported
Given the correct slice id is not supported by the service
When the request "getDevice" is sent
Then the response status code is 422
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 422
And the response property "$.code" is "SERVICE_NOT_APPLICABLE"
And the response property "$.message" is "The service is not available for the provided identifier."

@network_slice_booking_getDevice_09_inapposite_identifier_scenario
Scenario: Common validations for fail scenario of inapposite identifier
Given inapposite identifier or identifier is lost
When the request "getDevice" is sent
Then the response status code is 422
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 422
And the response property "$.code" such as "MISSING_IDENTIFIER", "UNSUPPORTED_IDENTIFIER" and "UNNECESSARY_IDENTIFIER"
And the response property "$.message" contains a user friendly text

@network_slice_booking_getDevice_10_quota_exceeded_scenario
Scenario: Error response for quota exceeded
Given the right request body property argument
When the request "getDevice" is sent
Then the response status code is 429
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 429
And the response property "$.code" is "QUOTA_EXCEEDED"
And the response property "$.message" is "Out of resource quota."

@network_slice_booking_getDevice_11_too_many_requests_scenario
Scenario: Error response for too many requests
Given the right request body property argument
When the request "getDevice" is sent
Then the response status code is 429
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 429
And the response property "$.code" is "TOO_MANY_REQUESTS"
And the response property "$.message" is "Rate limit reached."
Loading