CT#94 (35fd95ec) · Commits · All Groups / 5G APIs

TS24558_Eecs_ServiceProvisioning.yaml

0 → 100644

+407 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: Eecs_ServiceProvisioning
		description: \|
		API for ECS Service Provisioning.
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		version: "1.0.0-alpha.1"
		externalDocs:
		description: 3GPP TS 24.558 V0.6.0 Enabling Edge Applications; Protocol specification.
		url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/
		security:
		- {}
		- oAuth2ClientCredentials: []
		servers:
		- url: '{apiRoot}/eecs-serviceprovisioning/v1'
		variables:
		apiRoot:
		default: https://example.com
		description: apiRoot as defined in clause 7.5 of 3GPP TS 29.558
		paths:
		/provisioning-info/fetch:
		post:
		description: Provide the information required by the UE to access the edge services
		tags:
		- Provisioning Information
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ECSServProvReq'
		responses:
		'200':
		description: OK (The requested service provisioning information was returned successfully)
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ECSServProvResp'
		'204':
		description: No Content (the requested service provisioning information does not exist)
		'400':
		$ref: 'TS29122_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29122_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29122_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29122_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29122_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29122_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29122_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29122_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29122_CommonData.yaml#/components/responses/500'
		'503':
		$ref: 'TS29122_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'
		/subscriptions:
		post:
		description: Creates a new subscription in ECS in order to be notified of provisioning data changes of interest.
		tags:
		- Service Provisioning Subscriptions
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ECSServProvSubscription'
		callbacks:
		notificationDestination:
		'{request.body#/notificationDestination}':
		post:
		requestBody: # contents of the callback message
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ServProvNotification'
		responses:
		'204':
		description: No Content (successful notification)
		'307':
		$ref: 'TS29122_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29122_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29122_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29122_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29122_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29122_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29122_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29122_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29122_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29122_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29122_CommonData.yaml#/components/responses/500'
		'503':
		$ref: 'TS29122_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'
		responses:
		'201':
		description: Individual ECS Service Provisioning Subscription resource created successfully.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ECSServProvSubscription'
		headers:
		Location:
		description: 'Contains the URI of the newly created resource'
		required: true
		schema:
		type: string
		'400':
		$ref: 'TS29122_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29122_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29122_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29122_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29122_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29122_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29122_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29122_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29122_CommonData.yaml#/components/responses/500'
		'503':
		$ref: 'TS29122_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'

		/subscriptions/{subscriptionId}:
		put:
		description: Updates an existing individual service provisioning subscription identified by the subscriptionId.
		tags:
		- Individual Service Provisioning Subscription
		parameters:
		- name: subscriptionId
		in: path
		description: Identifies an individual service provisioning subscription
		required: true
		schema:
		type: string
		requestBody:
		description: Parameters to replace the existing subscription
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ECSServProvSubscription'
		responses:
		'200':
		description: OK (The individual service provisioning subscription matching the subscriptionId was modified successfully)
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/ECSServProvSubscription'
		'400':
		$ref: 'TS29122_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29122_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29122_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29122_CommonData.yaml#/components/responses/404'
		'411':
		$ref: 'TS29122_CommonData.yaml#/components/responses/411'
		'413':
		$ref: 'TS29122_CommonData.yaml#/components/responses/413'
		'415':
		$ref: 'TS29122_CommonData.yaml#/components/responses/415'
		'429':
		$ref: 'TS29122_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29122_CommonData.yaml#/components/responses/500'
		'503':
		$ref: 'TS29122_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'

		delete:
		description: Deletes an existing individual service provisioning subscription identified by the subscriptionId.
		tags:
		- Individual Service Provisioning Subscription
		parameters:
		- name: subscriptionId
		in: path
		description: Identifies an individual service provisioning subscription
		required: true
		schema:
		type: string
		responses:
		'204':
		description: The individual service provisioning subscription matching the subscriptionId is deleted.
		'307':
		$ref: 'TS29122_CommonData.yaml#/components/responses/307'
		'308':
		$ref: 'TS29122_CommonData.yaml#/components/responses/308'
		'400':
		$ref: 'TS29122_CommonData.yaml#/components/responses/400'
		'401':
		$ref: 'TS29122_CommonData.yaml#/components/responses/401'
		'403':
		$ref: 'TS29122_CommonData.yaml#/components/responses/403'
		'404':
		$ref: 'TS29122_CommonData.yaml#/components/responses/404'
		'429':
		$ref: 'TS29122_CommonData.yaml#/components/responses/429'
		'500':
		$ref: 'TS29122_CommonData.yaml#/components/responses/500'
		'503':
		$ref: 'TS29122_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'

		components:
		securitySchemes:
		oAuth2ClientCredentials:
		type: oauth2
		flows:
		clientCredentials:
		tokenUrl: '{tokenUrl}'
		scopes: {}
		schemas:
		ECSServProvReq:
		description: ECS service provisioning request information.
		type: object
		properties:
		eecId:
		type: string
		description: Represents a unique identifier of the EEC.
		ueId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
		# acProfs:
		# type: array
		# items:
		# $ref:
		# description: Information about services the EEC wants to connect to.
		# eecSvcContSupp:
		# type: array
		# items:
		# $ref: 'TS29558_CommonData.yaml#/components/schemas/ACRScenario'
		# description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.
		connInfo:
		type: array
		items:
		$ref: '#/components/schemas/ConnectivityInfo'
		description: List of connectivity information for the UE.
		locInf:
		$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'
		required:
		- eecId
		ECSServProvResp:
		description: ECS service provisioning response information.
		type: object
		properties:
		ednCnfgInfo:
		type: array
		items:
		$ref: '#/components/schemas/EDNConfigInfo'
		minItems: 1
		description: List of EDN configuration information.
		required:
		- ednCnfgInfo
		ECSServProvSubscription:
		description: Represents an individual service provisioning subscription resource.
		type: object
		properties:
		eecId:
		type: string
		description: Represents a unique identifier of the EEC.
		ueId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
		# acProfs:
		# type: array
		# items:
		# $ref:
		# description: Information about services the EEC wants to connect to.
		expTime:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
		# eecSvcContSupp:
		# type: array
		# items:
		# $ref: 'TS29558_CommonData.yaml#/components/schemas/ACRScenario'
		# description: Indicates if the EEC supports service continuity or not, also indicates which ACR scenarios are supported by the EEC.
		connInfo:
		type: array
		items:
		$ref: '#/components/schemas/ConnectivityInfo'
		description: List of connectivity information for the UE.
		notificationDestination:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
		requestTestNotification:
		type: boolean
		description: Set to true by Subscriber to request the ECS to send a test notification. Set to false or omitted otherwise.
		websockNotifConfig:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
		suppFeat:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		required:
		- eecId
		ServProvNotification:
		description: Represents notification information of a service provisioning Event.
		type: object
		properties:
		subId:
		type: string
		description: Identifier of the individual service provisioning subscription for which the service provisioning notification is delivered.
		ednCnfgInfo:
		type: array
		items:
		$ref: '#/components/schemas/EDNConfigInfo'
		minItems: 1
		description: List of EDN configuration information.
		required:
		- subId
		- ednCnfgInfo
		ConnectivityInfo:
		description: Represents the connectivity information for the UE.
		type: object
		properties:
		plmnId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
		ssId:
		type: string
		description: Identifies the SSID of the access point to which the UE is attached.
		EDNConfigInfo:
		description: Represents the EDN information.
		type: object
		properties:
		ednConInfo:
		$ref: '#/components/schemas/EDNConInfo'
		eess:
		type: array
		items:
		$ref: '#/components/schemas/EESInfo'
		minItems: 1
		description: Contains the list of EESs of the EDN.
		lifeTime:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
		required:
		- ednConInfo
		- eess
		EDNConInfo:
		description: Represents an EDN connection information .
		type: object
		properties:
		dnn:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
		snssai:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
		ednTopoSrvArea:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
		EESInfo:
		description: Represents EES information.
		type: object
		properties:
		eesId:
		type: string
		description: Identity of the EES
		# endPt:
		# $ref: 'TS29558_CommonData.yaml#/components/schemas/EndPoint'
		# description: Endpoint information (e.g. URI, FQDN, IP address) used to communicate with the EES.
		easIds:
		type: array
		items:
		type: string
		description: Identities of the Edge Application Servers registered with the EES.
		ecspInfo:
		type: string
		description: Represents an ECSP Information.
		svcArea:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
		dnais:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
		description: Represents list of Data network access identifier.
		# eesSvcContSupp:
		# type: array
		# items:
		# $ref: 'TS29558_CommonData.yaml#/components/schemas/ACRScenario'
		# description: Indicates if the EES supports service continuity or not, also indicates which ACR scenarios are supported by the EES.
		eecRegConf:
		type: boolean
		description: Indicates whether the EEC is required to register on the EES to use edge services or not.
		required:
		- eesId
		- eecRegConf

TS24558_Eees_EASDiscovery.yaml

0 → 100644

+471 −0

File added.

Preview size limit exceeded, changes collapsed.

TS29122_AsSessionWithQoS.yaml

+58 −16

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-as-session-with-qos
		version: 1.2.0-alpha.2
		version: 1.2.0-alpha.3
		description: \|
		API for setting us an AS session with required QoS.
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V17.3.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V17.4.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -21,9 +21,10 @@ servers:
		paths:
		/{scsAsId}/subscriptions:
		get:
		summary: read all of the active subscriptions for the SCS/AS
		summary: Read all of the active subscriptions for the SCS/AS.
		operationId: FetchAllASSessionWithQoSSubscriptions
		tags:
		- AsSessionWithQoS API SCS/AS level GET Operation
		- AS Session with Required QoS Subscriptions
		parameters:
		- name: scsAsId
		in: path
		@@ -31,6 +32,30 @@ paths:
		required: true
		schema:
		type: string
		- name: ip-addrs
		in: query
		description: The IP address(es) of the requested UE(s).
		required: false
		schema:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
		minItems: 1
		- name: ip-domain
		in: query
		description: The IPv4 address domain identifier. The attribute may only be provided if IPv4 address is included in the ip-addrs query parameter.
		required: false
		schema:
		type: string
		- name: mac-addrs
		in: query
		description: The MAC address(es) of the requested UE(s).
		required: false
		schema:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
		minItems: 1
		responses:
		'200':
		description: OK.
		@@ -64,9 +89,10 @@ paths:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'

		post:
		summary: Creates a new subscription resource
		summary: Creates a new subscription resource.
		operationId: CreateASSessionWithQoSSubscription
		tags:
		- AsSessionWithQoS API Subscription level POST Operation
		- AS Session with Required QoS Subscriptions
		parameters:
		- name: scsAsId
		in: path
		@@ -158,9 +184,10 @@ paths:

		/{scsAsId}/subscriptions/{subscriptionId}:
		get:
		summary: read an active subscriptions for the SCS/AS and the subscription Id
		summary: Read an active subscriptions for the SCS/AS and the subscription Id.
		operationId: FetchIndASSessionWithQoSSubscription
		tags:
		- AsSessionWithQoS API Subscription level GET Operation
		- Individual AS Session with Required QoS Subscription
		parameters:
		- name: scsAsId
		in: path
		@@ -205,9 +232,10 @@ paths:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'

		put:
		summary: Updates/replaces an existing subscription resource
		summary: Updates/replaces an existing subscription resource.
		operationId: UpdateIndASSessionWithQoSSubscription
		tags:
		- AsSessionWithQoS API subscription level PUT Operation
		- Individual AS Session with Required QoS Subscription
		parameters:
		- name: scsAsId
		in: path
		@@ -265,9 +293,10 @@ paths:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'

		patch:
		summary: Updates/replaces an existing subscription resource
		summary: Updates/replaces an existing subscription resource.
		operationId: ModifyIndASSessionWithQoSSubscription
		tags:
		- AsSessionWithQoS API subscription level PATCH Operation
		- Individual AS Session with Required QoS Subscription
		parameters:
		- name: scsAsId
		in: path
		@@ -324,9 +353,10 @@ paths:
		$ref: 'TS29122_CommonData.yaml#/components/responses/default'

		delete:
		summary: Deletes an already existing subscription
		summary: Deletes an already existing subscription.
		operationId: DeleteIndASSessionWithQoSSubscription
		tags:
		- AsSessionWithQoS API Subscription level DELETE Operation
		- Individual AS Session with Required QoS Subscription
		parameters:
		- name: scsAsId
		in: path
		@@ -432,7 +462,7 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'
		qosMonInfo:
		$ref: '#/components/schemas/QosMonitoringInformation'
		localNotifInd:
		directNotifInd:
		type: boolean
		tscQosReq:
		$ref: '#/components/schemas/TscQosRequirement'
		@@ -441,6 +471,12 @@ components:
		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:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'
		events:
		description: Represents the list of user plane event(s) to which the SCS/AS requests to subscribe to.
		type: array
		items:
		$ref: '#/components/schemas/UserPlaneEvent'
		minItems: 1
		required:
		- notificationDestination
		AsSessionWithQoSSubscriptionPatch:
		@@ -477,12 +513,18 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'
		qosMonInfo:
		$ref: '#/components/schemas/QosMonitoringInformationRm'
		localNotifInd:
		directNotifInd:
		type: boolean
		notificationDestination:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
		tscQosReq:
		$ref: '#/components/schemas/TscQosRequirementRm'
		events:
		description: Represents the updated list of user plane event(s) to which the SCS/AS requests to subscribe to.
		type: array
		items:
		$ref: '#/components/schemas/UserPlaneEvent'
		minItems: 1
		QosMonitoringInformation:
		description: Represents QoS monitoring information.
		type: object

TS29122_ChargeableParty.yaml

+42 −7

File changed.

Preview size limit exceeded, changes collapsed.

TS29122_CpProvisioning.yaml

+38 −2

File changed.

Preview size limit exceeded, changes collapsed.