Skip to content

Modify network-slice-assignment API Path and Feature Files #96

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 2 commits into from
Jan 30, 2026
Merged

Modify network-slice-assignment API Path and Feature Files #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dbffc94
Reformat network-slice-assignment API path
XunliYang Jan 26, 2026
105d8fa
Modify operation name
XunliYang Jan 26, 2026
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
126 changes: 62 additions & 64 deletions code/API_definitions/network-slice-assignment.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ tags:
- name: Network Slice Assignment
description: Manage Network Slice Assignment
paths:
/slices/devices/assign:
/slices/{sliceId}/devices:
post:
tags:
- Network Slice Assignment
Expand All @@ -85,8 +85,9 @@ paths:
operationId: assignDevice
security:
- openId:
- network-slice-assignment:devices:create
- network-slice-assignment:devices:assign
parameters:
- $ref: "#/components/parameters/sliceId"
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: Parameters to assign a device to a network slice
Expand Down Expand Up @@ -175,13 +176,50 @@ paths:
"429":
$ref: "#/components/responses/Generic429"

/slices/devices/release:
get:
tags:
- Network Slice Assignment
summary: Get devices assigned to a network slice
description: |
Get information about devices assigned to an existing network slice.
operationId: getDevices
security:
- openId:
- network-slice-assignment:devices:get
parameters:
- $ref: "#/components/parameters/sliceId"
- $ref: "#/components/parameters/x-correlator"
responses:
"200":
description: Contains information about active slice
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/SliceDevices"
examples:
GET_DEVICES_SUCCESSFUL:
$ref: "#/components/examples/GET_DEVICES_SUCCESSFUL"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"

/slices/{sliceId}/release:
post:
tags:
- Network Slice Assignment
summary: Release a device from an existing network slice
description: |
Unbind a device to an existing network slice.
Release a device from an existing network slice.
- If the release operation is successful, the response will indicate the status as `SUCCESS` with statusInfo as `RELEASE_COMPLETED`.
- If the device is not assigned to the slice, the response will indicate the status as `FAILURE` with statusInfo as `DEVICE_ALREADY_RELEASED`.

Expand All @@ -194,6 +232,7 @@ paths:
- openId:
- network-slice-assignment:devices:delete
parameters:
- $ref: "#/components/parameters/sliceId"
- $ref: "#/components/parameters/x-correlator"
requestBody:
description: Parameters to release a device from a network slice
Expand Down Expand Up @@ -239,54 +278,11 @@ paths:
"429":
$ref: "#/components/responses/Generic429"

/slices/devices/get/{sliceId}:
get:
tags:
- Network Slice Assignment
summary: Get devices assigned to a network slice
description: |
Get information about devices assigned to an existing network slice.
operationId: getDevices
security:
- openId:
- network-slice-assignment:devices:get
parameters:
- name: sliceId
in: path
description: Slice ID that was obtained from the createSlice operation
required: true
schema:
$ref: "#/components/schemas/SliceId"
- $ref: "#/components/parameters/x-correlator"
responses:
"200":
description: Contains information about active slice
headers:
x-correlator:
$ref: "#/components/headers/x-correlator"
content:
application/json:
schema:
$ref: "#/components/schemas/SliceDevice"
examples:
GET_DEVICES_SUCCESSFUL:
$ref: "#/components/examples/GET_DEVICES_SUCCESSFUL"
"400":
$ref: "#/components/responses/Generic400"
"401":
$ref: "#/components/responses/Generic401"
"403":
$ref: "#/components/responses/Generic403"
"404":
$ref: "#/components/responses/Generic404"
"429":
$ref: "#/components/responses/Generic429"

/slices/devices/retrieve:
/retrieve-slices:
post:
tags:
- Network Slice Assignment
summary: Retrieve all network slices corresponds to a device
summary: Retrieve all network slices by device
description: |
Retrieve the list of network slices to which a device is assigned.
operationId: retrieveSlicesByDevice
Expand Down Expand Up @@ -331,8 +327,14 @@ paths:
components:
securitySchemes:
openId:
description: OpenID Connect authentication
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
notificationsBearerAuth:
description: Bearer authentication for notifications
type: http
scheme: bearer
bearerFormat: "{$request.body#sinkCredential.credentialType}"

parameters:
x-correlator:
Expand All @@ -341,6 +343,13 @@ components:
description: Correlation id for the different services
schema:
$ref: "#/components/schemas/XCorrelator"
sliceId:
name: sliceId
in: path
description: Slice ID that was obtained from the createSlice operation
required: true
schema:
$ref: "#/components/schemas/SliceId"

headers:
x-correlator:
Expand All @@ -367,8 +376,6 @@ components:
properties:
device:
$ref: "#/components/schemas/Device"
sliceId:
$ref: "#/components/schemas/SliceId"
sink:
type: string
format: uri
Expand All @@ -378,8 +385,6 @@ components:
description: A sink credential provides authentication or authorization information necessary to enable delivery of events to a target.
allOf:
- $ref: "#/components/schemas/SinkCredential"
required:
- sliceId
Device:
description: |
End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.
Expand Down Expand Up @@ -469,11 +474,8 @@ components:
properties:
device:
$ref: "#/components/schemas/Device"
sliceId:
$ref: "#/components/schemas/SliceId"
required:
- device
- sliceId
DeviceAssignmentInfo:
description: |
Information about the device assignment operation returned in the response.
Expand Down Expand Up @@ -570,7 +572,7 @@ components:
$ref: "#/components/schemas/SliceInfo"
minItems: 0

SliceDevice:
SliceDevices:
description: Information about devices assigned to a slice
type: object
properties:
Expand All @@ -587,15 +589,15 @@ components:
SliceInfo:
description: Slice related information.
allOf:
- $ref: "#/components/schemas/CreateSlice"
- $ref: "#/components/schemas/SliceAttributes"
- type: object
properties:
sliceId:
$ref: "#/components/schemas/SliceId"
required:
- sliceId
CreateSlice:
description: Attributes required to create a slice
SliceAttributes:
description: Attributes defining the characteristics of the slice
type: object
properties:
serviceTime:
Expand Down Expand Up @@ -1318,7 +1320,6 @@ components:
publicAddress: "84.125.93.10"
publicPort: 59765
ipv6Address: "2001:db8:85a3:8d3:1319:8a2e:370:7344"
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
sink:
"https://endpoint.example.com/sink"
sinkCredential:
Expand All @@ -1332,7 +1333,6 @@ components:
value:
device:
phoneNumber: "+123456789"
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
sink:
"https://endpoint.example.com/sink"
sinkCredential:
Expand Down Expand Up @@ -1400,7 +1400,6 @@ components:
value:
device:
phoneNumber: "+123456789"
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
RELEASE_DEVICE_INPUT_ALL:
summary: Release device - All Identifiers
description: Example of request to assign a device to a network slice using all identifiers
Expand All @@ -1412,7 +1411,6 @@ components:
publicAddress: "84.125.93.10"
publicPort: 59765
ipv6Address: "2001:db8:85a3:8d3:1319:8a2e:370:7344"
sliceId: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
RELEASE_DEVICE_SUCCESSFUL:
summary: Release Successful
description: Example of successful response for releasing a device from a network slice request
Expand Down
14 changes: 10 additions & 4 deletions code/API_definitions/network-slice-booking.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/CreateSlice"
$ref: "#/components/schemas/SliceAttributes"
examples:
LOCATION_CIRCLE:
$ref: "#/components/examples/RETRIEVAL_CIRCLE"
Expand Down Expand Up @@ -249,8 +249,14 @@ paths:
components:
securitySchemes:
openId:
description: Bearer authentication for notifications
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
notificationsBearerAuth:
description: Bearer authentication for notifications
type: http
scheme: bearer
bearerFormat: "{$request.body#sinkCredential.credentialType}"

parameters:
x-correlator:
Expand Down Expand Up @@ -279,16 +285,16 @@ components:
SliceInfo:
description: Slice related information.
allOf:
- $ref: "#/components/schemas/CreateSlice"
- $ref: "#/components/schemas/SliceAttributes"
- type: object
properties:
sliceId:
$ref: "#/components/schemas/SliceId"
required:
- sliceId

CreateSlice:
description: Attributes required to create a slice
SliceAttributes:
description: Attributes defining the characteristics of the slice
type: object
properties:
serviceTime:
Expand Down
Loading