CT#87 (fa8850fb) · Commits · All Groups / 5G APIs

TS29122_AsSessionWithQoS.yaml

+155 −5

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-as-session-with-qos
		version: 1.1.0.alpha-1
		version: 1.1.0.alpha-2
		description: \|
		API for setting us an AS session with required QoS.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V16.3.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V16.5.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -86,7 +86,7 @@ paths:
		content:
		application/json:
		schema:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/NotificationData'
		$ref: '#/components/schemas/UserPlaneNotificationData'
		responses:
		'204':
		description: No Content (successful notification)
		@@ -368,6 +368,12 @@ components:
		qosReference:
		type: string
		description: Identifies a pre-defined QoS information
		altQoSReferences:
		type: array
		items:
		type: string
		minItems: 1
		description: Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority.
		ueIpv4Addr:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
		ueIpv6Addr:
		@@ -378,6 +384,8 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'
		sponsorInfo:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/SponsorInformation'
		qosMonInfo:
		$ref: '#/components/schemas/QosMonitoringInformation'
		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.
		@@ -403,5 +411,147 @@ components:
		qosReference:
		type: string
		description: Pre-defined QoS reference
		altQoSReferences:
		type: array
		items:
		type: string
		minItems: 1
		description: Identifies an ordered list of pre-defined QoS information. The lower the index of the array for a given entry, the higher the priority.
		usageThreshold:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'
		qosMonInfo:
		$ref: '#/components/schemas/QosMonitoringInformationRm'
		QosMonitoringInformation:
		type: object
		properties:
		reqQosMonParams:
		type: array
		items:
		$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter'
		minItems: 1
		repFreqs:
		type: array
		items:
		$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency'
		minItems: 1
		repThreshDl:
		type: integer
		repThreshUl:
		type: integer
		repThreshRp:
		type: integer
		waitTime:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		repPeriod:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		QosMonitoringInformationRm:
		type: object
		properties:
		reqQosMonParams:
		type: array
		items:
		$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter'
		minItems: 1
		repFreqs:
		type: array
		items:
		$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ReportingFrequency'
		minItems: 1
		repThreshDl:
		type: integer
		nullable: true
		repThreshUl:
		type: integer
		nullable: true
		repThreshRp:
		type: integer
		nullable: true
		waitTime:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		repPeriod:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm'
		QosMonitoringReport:
		type: object
		properties:
		ulDelays:
		type: array
		items:
		type: integer
		minItems: 1
		dlDelays:
		type: array
		items:
		type: integer
		minItems: 1
		rtDelays:
		type: array
		items:
		type: integer
		minItems: 1
		UserPlaneNotificationData:
		type: object
		properties:
		transaction:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Link'
		eventReports:
		type: array
		items:
		$ref: '#/components/schemas/UserPlaneEventReport'
		minItems: 1
		description: Contains the reported event and applicable information
		required:
		- transaction
		- eventReports
		UserPlaneEventReport:
		type: object
		properties:
		event:
		$ref: '#/components/schemas/UserPlaneEvent'
		accumulatedUsage:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage'
		flowIds:
		type: array
		items:
		type: integer
		minItems: 1
		description: Identifies the IP flows that were sent during event subscription
		appliedQosRef:
		type: string
		description: The currently applied QoS reference. Applicable for event QOS_NOT_GUARANTEED.
		qosMonReports:
		type: array
		items:
		$ref: '#/components/schemas/QosMonitoringReport'
		minItems: 1
		description: Contains the QoS Monitoring Reporting information
		required:
		- event
		UserPlaneEvent:
		anyOf:
		- type: string
		enum:
		- SESSION_TERMINATION
		- LOSS_OF_BEARER
		- RECOVERY_OF_BEARER
		- RELEASE_OF_BEARER
		- USAGE_REPORT
		- FAILED_RESOURCES_ALLOCATION
		- QOS_GUARANTEED
		- QOS_NOT_GUARANTEED
		- QOS_MONITORING
		- type: string
		description: >
		This string provides forward-compatibility with future
		extensions to the enumeration but is not used to encode
		content defined in the present version of this API.
		description: >
		Possible values are
		- SESSION_TERMINATION: Indicates that Rx session is terminated.
		- LOSS_OF_BEARER : Indicates a loss of a bearer.
		- RECOVERY_OF_BEARER: Indicates a recovery of a bearer.
		- RELEASE_OF_BEARER: Indicates a release of a bearer.
		- USAGE_REPORT: Indicates the usage report event.
		- FAILED_RESOURCES_ALLOCATION: Indicates the resource allocation is failed.
		- QOS_GUARANTEED: The QoS targets of one or more SDFs are guaranteed again.
		- QOS_NOT_GUARANTEED: The QoS targets of one or more SDFs are not being guaranteed.
		- QOS_MONITORING: Indicates a QoS monitoring event.

TS29122_CommonData.yaml

+9 −5

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: TS 29.122 Common Data Types
		version: 1.1.0.alpha-1
		version: 1.1.0.alpha-2
		description: \|
		Data types applicable to several APIs.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V16.3.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V16.5.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		paths: {}
		components:
		@@ -266,6 +266,10 @@ components:
		BdtReferenceId:
		type: string
		description: string identifying a BDT Reference ID as defined in subclause 5.3.3 of 3GPP TS 29.154.
		BdtReferenceIdRm:
		type: string
		description: This data type is defined in the same way as the BdtReferenceId data type, but with the nullable property set to true.
		nullable: true
		Binary:
		type: string
		description: string with format "binary" as defined in OpenAPI Specification.

TS29122_MonitoringEvent.yaml

+27 −15

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-monitoring-event
		version: 1.1.0.alpha-4
		version: 1.1.0.alpha-5
		description: \|
		API for Monitoring Event.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V16.4.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V16.5.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -381,12 +381,16 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea'
		locationArea5G:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
		dddTraDes:
		$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/DddTrafficDescriptor'
		dddTraDescriptors:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor'
		minItems: 1
		dddStati:
		type: array
		items:
		$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/DddStatus'
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus'
		minItems: 1
		apiNames:
		type: array
		items:
		@@ -460,7 +464,9 @@ components:
		pdnConnInfo:
		$ref: '#/components/schemas/PdnConnectionInformation'
		dddStatus:
		$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/DddStatus'
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus'
		dddTrafDescriptor:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor'
		maxWaitTime:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
		apiCaps:
		@@ -570,14 +576,14 @@ components:
		$ref: '#/components/schemas/InterfaceIndication'
		ipv4Addr:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr'
		ipv6Addr:
		ipv6Addrs:
		type: array
		items:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr'
		minItems: 1
		required:
		- status
		- pdnType
		anyOf:
		- required: [ipv4Addr]
		- required: [ipv6Addr]
		AppliedParameterConfiguration:
		type: object
		properties:
		@@ -729,8 +735,11 @@ components:
		anyOf:
		- type: string
		enum:
		- IP
		- IPV4
		- IPV6
		- IPV4V6
		- NON_IP
		- ETHERNET
		- type: string
		description: >
		This string provides forward-compatibility with future
		@@ -738,8 +747,11 @@ components:
		content defined in the present version of this API.
		description: >
		Possible values are
		- IP: PDN connection of IP type.
		- IPV4: PDN connection of IPv4 type.
		- IPV6: PDN connection of IPv6 type.
		- IPV4V6: PDN connection of IPv4v6 type.
		- NON_IP: PDN connection of non-IP type.
		- ETHERNET: PDN connection of Ethernet type.
		InterfaceIndication:
		anyOf:
		- type: string

TS29122_NIDD.yaml

+6 −20

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-nidd
		version: 1.1.0.alpha-1
		version: 1.1.0.alpha-2
		description: \|
		API for non IP data delivery.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V16.4.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V16.5.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -680,22 +680,8 @@ components:
		- SEND_TRIGGER: send a device trigger
		PdnEstablishmentOptionsRm:
		anyOf:
		- type: string
		enum:
		- WAIT_FOR_UE
		- INDICATE_ERROR
		- SEND_TRIGGER
		- type: string
		description: >
		This string provides forward-compatibility with future
		extensions to the enumeration but is not used to encode
		content defined in the present version of this API.
		description: >
		Possible values are
		- WAIT_FOR_UE: wait for the UE to establish the PDN connection
		- INDICATE_ERROR: respond with an error cause
		- SEND_TRIGGER: send a device trigger
		nullable: true
		- $ref: '#/components/schemas/PdnEstablishmentOptions'
		- $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue'
		DeliveryStatus:
		anyOf:
		- type: string

TS29122_ResourceManagementOfBdt.yaml

+9 −3

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 3gpp-bdt
		version: 1.1.0.alpha-3
		version: 1.1.0.alpha-4
		description: \|
		API for BDT resouce management.
		© 2019, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 29.122 V16.4.0 T8 reference point for Northbound APIs
		description: 3GPP TS 29.122 V16.5.0 T8 reference point for Northbound APIs
		url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'
		security:
		- {}
		@@ -364,5 +364,11 @@ components:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
		timeWindow:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
		candPolicies:
		type: array
		items:
		$ref: '#/components/schemas/TransferPolicy'
		minItems: 1
		description: This IE indicates a list of the candidate transfer policies from which the AF may select a new transfer policy due to network performance degradation.
		required:
		- bdtRefId

Admin message