AsSessionWithQoS

API for setting us an AS session with required QoS.

OpenAPI

OpenAPI Version: 3.0.0

info

Title: 3gpp-as-session-with-qos

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security

- {}

- oAuth2ClientCredentials: []

servers

URL: '{apiRoot}/3gpp-as-session-with-qos/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.

paths

/{scsAsId}/subscriptions

get:

Summary: read all of the active subscriptions for the SCS/AS

Tags:

- AsSessionWithQoS API SCS/AS level GET Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK.

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/AsSessionWithQoSSubscription'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Method: Post

Summary: Creates a new subscription resource

Tags:

- AsSessionWithQoS API Subscription level POST Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

Request Body:

Description: Request to create a new subscription resource

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AsSessionWithQoSSubscription'

Callbacks:

notificationDestination:

'{request.body#/notificationDestination}':

Method: Post

Request Body: # contents of the callback message

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/NotificationData'

Responses:

'204' No Content (successful notification)

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Responses:

'201' Created (Successful creation of subscription)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AsSessionWithQoSSubscription'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

/{scsAsId}/subscriptions/{subscriptionId}

get:

Summary: read an active subscriptions for the SCS/AS and the subscription Id

Tags:

- AsSessionWithQoS API Subscription level GET Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Identifier of the subscription resource

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (Successful get the active subscription)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AsSessionWithQoSSubscription'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

put:

Summary: Updates/replaces an existing subscription resource

Tags:

- AsSessionWithQoS API subscription level PUT Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Identifier of the subscription resource

Required/Optional: true

Schema:

Type: string

Request Body:

Description: Parameters to update/replace the existing subscription

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AsSessionWithQoSSubscription'

Responses:

'200' OK (Successful update of the subscription)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AsSessionWithQoSSubscription'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

patch:

Summary: Updates/replaces an existing subscription resource

Tags:

- AsSessionWithQoS API subscription level PATCH Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Identifier of the subscription resource

Required/Optional: true

Schema:

Type: string

Request Body:

Required/Optional: true

Content:

application/merge-patch+json:

Schema:

Reference: '#/components/schemas/AsSessionWithQoSSubscriptionPatch'

Responses:

'200' OK. The subscription was modified successfully.

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/AsSessionWithQoSSubscription'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

delete:

Summary: Deletes an already existing subscription

Tags:

- AsSessionWithQoS API Subscription level DELETE Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Type: string

- name: subscriptionId

In: path

Description: Identifier of the subscription resource

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content (Successful deletion of the existing subscription)

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{tokenUrl}'

scopes: {}

schemas

AsSessionWithQoSSubscription

Type: object

Properties:

self:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

notificationDestination:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

flowInfo:

Type: array

Items:

Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'

minItems: 1

Description: Describe the data flow which requires QoS.

ethFlowInfo:

Type: array

Items:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'

minItems: 1

Description: Identifies Ethernet packet flows.

qosReference:

Type: string

Description: Identifies a pre-defined QoS information

ueIpv4Addr:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'

ueIpv6Addr:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr'

macAddr:

Reference: 'TS29571_CommonData.yaml#/components/schemas/macAddr48'

usageThreshold:

Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'

sponsorInfo:

Reference: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'

requestTestNotification:

Type: boolean

Description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

websockNotifConfig:

Reference: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

Required:

- notificationDestination

AsSessionWithQoSSubscriptionPatch

Type: object

Properties:

flowInfo:

Type: array

Items:

Reference: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'

minItems: 1

Description: Describe the data flow which requires QoS.

ethFlowInfo:

Type: array

Items:

Reference: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription'

minItems: 1

Description: Identifies Ethernet packet flows.

qosReference:

Type: string

Description: Pre-defined QoS reference

usageThreshold:

Reference: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'