CT#92 (98d9498b) · Commits · SA4 / 5GMS_Pro_Ph2

TS29122_AsSessionWithQoS.yaml

+77 −2

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-as-session-with-qos
		version: 1.1.3
		version: 1.2.0-alpha.1
		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 V16.9.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V17.2.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -235,6 +235,8 @@ paths:
		application/json:
		schema:
		$ref: '#/components/schemas/AsSessionWithQoSSubscription'
		'204':
		description: No Content (Successful update of the subscription)
		'307':
		$ref: 'TS29122_CommonData.yaml#/components/responses/307'
		'308':
		@@ -292,6 +294,8 @@ paths:
		application/json:
		schema:
		$ref: '#/components/schemas/AsSessionWithQoSSubscription'
		'204':
		description: No Content. The subscription was modified successfully.
		'307':
		$ref: 'TS29122_CommonData.yaml#/components/responses/307'
		'308':
		@@ -375,14 +379,22 @@ components:
		scopes: {}
		schemas:
		AsSessionWithQoSSubscription:
		description: Represents an individual AS session with required QoS subscription resource.
		type: object
		properties:
		self:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
		supportedFeatures:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		dnn:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
		snssai:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
		notificationDestination:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
		exterAppId:
		type: string
		description: Identifies the external Application Identifier.
		flowInfo:
		type: array
		items:
		@@ -420,6 +432,10 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'
		qosMonInfo:
		$ref: '#/components/schemas/QosMonitoringInformation'
		localNotifInd:
		type: boolean
		tscQosReq:
		$ref: '#/components/schemas/TscQosRequirement'
		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.
		@@ -428,8 +444,12 @@ components:
		required:
		- notificationDestination
		AsSessionWithQoSSubscriptionPatch:
		description: Represents parameters to modify an AS session with specific QoS subscription.
		type: object
		properties:
		exterAppId:
		type: string
		description: Identifies the external Application Identifier.
		flowInfo:
		type: array
		items:
		@@ -457,7 +477,14 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'
		qosMonInfo:
		$ref: '#/components/schemas/QosMonitoringInformationRm'
		localNotifInd:
		type: boolean
		notificationDestination:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
		tscQosReq:
		$ref: '#/components/schemas/TscQosRequirementRm'
		QosMonitoringInformation:
		description: Represents QoS monitoring information.
		type: object
		properties:
		reqQosMonParams:
		@@ -484,6 +511,7 @@ components:
		- reqQosMonParams
		- repFreqs
		QosMonitoringInformationRm:
		description: Represents the same as the QosMonitoringInformation data type but with the nullable:true property.
		type: object
		properties:
		reqQosMonParams:
		@@ -507,6 +535,7 @@ components:
		repPeriod:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
		QosMonitoringReport:
		description: Represents a QoS monitoring report.
		type: object
		properties:
		ulDelays:
		@@ -525,6 +554,7 @@ components:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		minItems: 1
		UserPlaneNotificationData:
		description: Represents the parameters to be conveyed in a user plane event(s) notification.
		type: object
		properties:
		transaction:
		@@ -539,6 +569,7 @@ components:
		- transaction
		- eventReports
		UserPlaneEventReport:
		description: Represents an event report for user plane.
		type: object
		properties:
		event:
		@@ -562,6 +593,50 @@ components:
		description: Contains the QoS Monitoring Reporting information
		required:
		- event
		TscQosRequirement:
		description: Represents QoS requirements for time sensitive communication.
		type: object
		properties:
		reqGbrDl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		reqGbrUl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		reqMbrDl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		reqMbrUl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		maxTscBurstSize:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol'
		req5Gsdelay:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
		tscaiTimeDom:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		tscaiInputDl:
		$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
		tscaiInputUl:
		$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
		TscQosRequirementRm:
		description: Represents the same as the TscQosRequirement data type but with the nullable:true property.
		type: object
		properties:
		reqGbrDl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		reqGbrUl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		reqMbrDl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		reqMbrUl:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		maxTscBurstSize:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm'
		req5Gsdelay:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm'
		tscaiTimeDom:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		tscaiInputDl:
		$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
		tscaiInputUl:
		$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
		UserPlaneEvent:
		anyOf:
		- type: string

TS29122_ChargeableParty.yaml

+19 −3

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-chargeable-party
		version: 1.2.0-alpha.2
		version: 1.2.0-alpha.3
		description: \|
		API for Chargeable Party management.
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V17.1.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V17.2.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -237,6 +237,8 @@ paths:
		application/json:
		schema:
		$ref: '#/components/schemas/ChargeableParty'
		'204':
		description: No Content
		'307':
		$ref: 'TS29122_CommonData.yaml#/components/responses/307'
		'308':
		@@ -320,12 +322,17 @@ components:
		scopes: {}
		schemas:
		ChargeableParty:
		description: Represents the configuration of a chargeable party.
		type: object
		properties:
		self:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
		supportedFeatures:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		dnn:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
		snssai:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
		notificationDestination:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
		requestTestNotification:
		@@ -333,6 +340,9 @@ 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'
		exterAppId:
		type: string
		description: Identifies the external Application Identifier.
		ipv4Addr:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
		ipDomain:
		@@ -369,6 +379,7 @@ components:
		- sponsorInformation
		- sponsoringEnabled
		ChargeablePartyPatch:
		description: Represents a modification request of a chargeable party resource.
		type: object
		properties:
		flowInfo:
		@@ -376,7 +387,10 @@ components:
		items:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo'
		minItems: 1
		description: Describes the application flows.
		description: Describes the IP flows.
		exterAppId:
		type: string
		description: Identifies the external Application Identifier.
		ethFlowInfo:
		type: array
		items:
		@@ -390,3 +404,5 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'
		usageThreshold:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'
		notificationDestination:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'

TS29122_CommonData.yaml

+19 −2

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: TS 29.122 Common Data Types
		version: 1.2.0-alpha.2
		version: 1.2.0-alpha.3
		description: \|
		Data types applicable to several APIs.
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V17.1.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V17.2.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		paths: {}
		components:
		schemas:
		SponsorInformation:
		description: Represents a sponsor information.
		type: object
		properties:
		sponsorId:
		@@ -25,6 +26,7 @@ components:
		- sponsorId
		- aspId
		UsageThreshold:
		description: Represents a usage threshold.
		type: object
		properties:
		duration:
		@@ -36,6 +38,7 @@ components:
		uplinkVolume:
		$ref: '#/components/schemas/Volume'
		UsageThresholdRm:
		description: Represents the same as the UsageThreshold data type but with the nullable:true property.
		type: object
		properties:
		duration:
		@@ -48,6 +51,7 @@ components:
		$ref: '#/components/schemas/VolumeRm'
		nullable: true
		TimeWindow:
		description: Represents a time window identified by a start time and a stop time.
		type: object
		properties:
		startTime:
		@@ -58,6 +62,7 @@ components:
		- startTime
		- stopTime
		Acknowledgement:
		description: Represents a successful acknowledgement of a notification.
		type: object
		properties:
		details:
		@@ -66,6 +71,7 @@ components:
		required:
		- details
		NotificationData:
		description: Represents the information to be conveyed in a bearer level event(s) notification.
		type: object
		properties:
		transaction:
		@@ -80,6 +86,7 @@ components:
		- transaction
		- eventReports
		EventReport:
		description: Represents an event report.
		type: object
		properties:
		event:
		@@ -95,6 +102,7 @@ components:
		required:
		- event
		AccumulatedUsage:
		description: Represents an accumulated usage.
		type: object
		properties:
		duration:
		@@ -106,6 +114,7 @@ components:
		uplinkVolume:
		$ref: '#/components/schemas/Volume'
		FlowInfo:
		description: Represents flow information.
		type: object
		properties:
		flowId:
		@@ -121,6 +130,7 @@ components:
		required:
		- flowId
		TestNotification:
		description: Represents a notification that can be sent to test whether a chosen notification mechanism works.
		type: object
		properties:
		subscription:
		@@ -128,6 +138,7 @@ components:
		required:
		- subscription
		WebsockNotifConfig:
		description: Represents the configuration information for the delivery of notifications over Websockets.
		type: object
		properties:
		websocketUri:
		@@ -136,6 +147,7 @@ components:
		type: boolean
		description: Set by the SCS/AS to indicate that the Websocket delivery is requested.
		LocationArea:
		description: Represents a user location area.
		type: object
		properties:
		cellIds:
		@@ -175,6 +187,7 @@ components:
		minItems: 1
		description: Identifies a list of civic addresses of the user where the UE is located.
		LocationArea5G:
		description: Represents a user location area when the UE is attached to 5G.
		type: object
		properties:
		geographicAreas:
		@@ -192,6 +205,7 @@ components:
		nwAreaInfo:
		$ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'
		ProblemDetails:
		description: Represents additional information and details on an error response.
		type: object
		properties:
		type:
		@@ -219,6 +233,7 @@ components:
		supportedFeatures:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
		InvalidParam:
		description: Represents the description of invalid parameters, for a request rejected due to invalid parameters.
		type: object
		properties:
		param:
		@@ -230,6 +245,7 @@ components:
		required:
		- param
		PlmnId:
		description: Represents the identifier of a PLMN.
		type: object
		properties:
		mcc:
		@@ -240,6 +256,7 @@ components:
		- mcc
		- mnc
		ConfigResult:
		description: Represents one configuration processing result for a group's members.
		type: object
		properties:
		externalIds:

TS29122_CpProvisioning.yaml

+7 −2

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-cp-parameter-provisioning
		version: 1.2.0-alpha.1
		version: 1.2.0-alpha.2
		description: \|
		API for provisioning communication pattern parameters.
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V17.1.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V17.2.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -444,6 +444,7 @@ components:
		scopes: {}
		schemas:
		CpInfo:
		description: Represents the resources for communication pattern parameter provisioning.
		type: object
		properties:
		self:
		@@ -479,6 +480,7 @@ components:
		- required: [msisdn]
		- required: [externalGroupId]
		CpParameterSet:
		description: Represents an offered communication pattern parameter set.
		type: object
		properties:
		setId:
		@@ -518,6 +520,7 @@ components:
		required:
		- setId
		ScheduledCommunicationTime:
		description: Represents an offered scheduled communication time.
		type: object
		properties:
		daysOfWeek:
		@@ -532,6 +535,7 @@ components:
		timeOfDayEnd:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeOfDay'
		CpReport:
		description: Represents a CP report indicating the CP set identifier(s) which CP parameter(s) are not added or modified successfully and the corresponding failure cause(s).
		type: object
		properties:
		setIds:
		@@ -545,6 +549,7 @@ components:
		required:
		- failureCode
		UmtLocationArea5G:
		description: Represents the user location area describing the UE moving trajectory.
		allOf:
		- $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
		- type: object

TS29122_DeviceTriggering.yaml

+4 −2

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-device-triggering
		version: 1.1.0
		version: 1.2.0-alpha.1
		description: \|
		API for device trigger.
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V16.9.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V17.2.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -320,6 +320,7 @@ components:
		scopes: {}
		schemas:
		DeviceTriggering:
		description: Represents device triggering related information.
		type: object
		properties:
		self:
		@@ -359,6 +360,7 @@ components:
		- required: [externalId]
		- required: [msisdn]
		DeviceTriggeringDeliveryReportNotification:
		description: Represents a device triggering delivery report notification.
		type: object
		properties:
		transaction: