Draft version after CT4#130 (fbcb7c4a) · Commits · All Groups / 5G APIs

TS29571_CommonData.yaml

+7584 −7538

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		version: '1.6.0-alpha.4'
		version: '1.6.0-alpha.5'


		title: 'Common Data Types'
		@@ -11,7 +11,7 @@ info:
		All rights reserved.

		externalDocs:
		description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 19.3.0
		description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 19.4.0
		url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/'

		paths: {}
		@@ -239,7 +239,7 @@ components:
		6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in
		hexadecimal representation Each character in the string shall take a value of "0" to "9",
		"a" to "f" or "A" to "F" and shall represent the support of 4 features as described in
		table 5.2.2-3. The most significant character representing the highest-numbered features
		table 5.2.2-3. The most significant character representing the highest-numbered features
		shall appear first in the string, and the character representing features 1 to 4
		shall appear last in the string. The list of features and their numbering (starting with 1)
		are defined separately for each API. If the string contains a lower number of characters
		@@ -339,7 +339,7 @@ components:
		description: \|
		String with format "time-numoffset" optionally appended by "daylightSavingTime", where
		- "time-numoffset" shall represent the time zone adjusted for daylight saving time and be
		encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
		encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
		- "daylightSavingTime" shall represent the adjustment that has been made and shall be
		encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

		@@ -945,18 +945,20 @@ components:
		description: NF Signalling Information
		type: object
		properties:
		nfInstanceId:
		$ref: '#/components/schemas/NfInstanceId'
		nfSigInfoPerWndw:
		type: array
		items:
		$ref: '#/components/schemas/NfSignallingInfoPerTimeWindow'
		minItems: 1
		avgReqProcTime:
		$ref: '#/components/schemas/Uinteger'
		nfHeartbeatInfo:
		$ref: '#/components/schemas/NfHeartbeatInfo'
		unexpStatusInd:
		type: boolean
		default: false
		required:
		- nfInstanceId

		NfSignallingInfoPerTimeWindow:
		description: NF Signalling Information Per time window
		@@ -965,13 +967,10 @@ components:
		tw:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
		nfSigInfoPerService:
		description: >
		The key of the map is the "serviceName" attribute of the NfSignallingInfoPerService data
		type.
		type: object
		additionalProperties:
		type: array
		items:
		$ref: '#/components/schemas/NfSignallingInfoPerService'
		minProperties: 1
		minItems: 1
		required:
		- tw
		- nfSigInfoPerService
		@@ -980,8 +979,12 @@ components:
		description: NF signalling information per service.
		type: object
		properties:
		nfServiceInstanceId:
		type: string
		serviceName:
		$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
		avgProcTime:
		$ref: '#/components/schemas/Float'
		numOfReq:
		$ref: '#/components/schemas/Uinteger'
		numOfReqUnresp:
		@@ -993,6 +996,7 @@ components:
		numOfPosteriorReq:
		$ref: '#/components/schemas/Uinteger'
		required:
		- nfServiceInstanceId
		- serviceName

		NfHeartbeatInfo:
		@@ -1158,9 +1162,8 @@ components:
		type: string
		pattern: '^[A-Fa-f0-9]{2}$'
		description: >
		String identifying the AMF Set ID (10 bits) as specified in clause 2.10.1 of 3GPP TS 23.003.
		It is encoded as a string of 3 hexadecimal characters where the first character is limited
		to values 0 to 3 (i.e. 10 bits)
		String identifying the AMF Region (8 bits) as specified in clause 2.10.1 of
		3GPP TS 23.003. It is encoded as a string of 2 hexadecimal characters (i.e. 8 bits).

		AmfSetId:
		type: string
		@@ -1338,13 +1341,12 @@ components:
		type: string
		pattern: '(^[A-Fa-f0-9]{4}$)\|(^[A-Fa-f0-9]{6}$)'
		description: >
		2 or 3-octet string identifying a tracking area code as specified in clause 9.3.3.10
		of 3GPP TS 38.413, in hexadecimal representation. Each character in the string shall
		take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The
		most significant character representing the 4 most significant bits of the TAC shall
		2 or 3-octet string identifying a tracking area code as specified in clause 9.3.3.16 or
		9.3.3.10 of 3GPP TS 38.413, in hexadecimal representation. Each character in the string
		shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits.
		The most significant character representing the 4 most significant bits of the TAC shall
		appear first in the string, and the character representing the 4 least significant bit
		of the TAC shall appear last in the string.

		TacRm:
		type: string
		pattern: '(^[A-Fa-f0-9]{4}$)\|(^[A-Fa-f0-9]{6}$)'
		@@ -1505,7 +1507,7 @@ components:
		<MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits.
		If there are only 2 significant digits in the MNC, one "0" digit shall be inserted
		at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$'
		<NID> encoded as defined in clause 5.4.2 ("Nid" data type definition)
		<NID> encoded as defined in clause 5.4.2 ("Nid" data type definition)
		<NFInstanceId> encoded as defined in clause 5.3.2
		<ServiceName> encoded as defined in 3GPP TS 29.510
		<Set ID> encoded as a string of characters consisting of alphabetic
		@@ -1632,6 +1634,12 @@ components:
		EnergySavingIndicator:
		$ref: '#/components/schemas/Uinteger'

		OverloadControlInfo:
		description: >
		String representing the Overload Control Information as defined in clause 5.2.3.2.9 of 3GPP
		TS 29.500.
		type: string


		#
		# ENUMERATED DATA TYPES
		@@ -1689,7 +1697,7 @@ components:
		- LTE_M_GEO
		- LTE_M_OTHERSAT
		- NR_EREDCAP
		- type: string
		- HSPA_EVOLUTION - type: string
		description: Indicates the radio access used.

		RatTypeRm:
		@@ -2169,6 +2177,15 @@ components:
		- OTHER
		- type: string

		CagProvisionOperation:
		description: CAG provision operation
		anyOf:
		- type: string
		enum:
		- ADD
		- REPLACE
		- REMOVE
		- type: string

		#
		# STRUCTURED DATA TYPES
		@@ -2879,7 +2896,7 @@ components:
		default: false
		description: >
		Indicates the support of Access Traffic Steering, Switching and Splitting procedures
		using the MPTCP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501
		using the MPTCP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501
		true: Supported
		false (default): Not Supported
		mpquic:
		@@ -2887,7 +2904,7 @@ components:
		default: false
		description: >
		Indicates the support of Access Traffic Steering, Switching and Splitting procedures
		using the MPQUIC-UDP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
		using the MPQUIC-UDP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
		true: Supported
		false (default): Not Supported
		rttWithoutPmf:
		@@ -2895,7 +2912,7 @@ components:
		default: false
		description: >
		This IE is only used by the UPF to indicate whether the UPF supports RTT measurement
		without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501
		without PMF (see clauses 5.32.2, 6.3.3.3 of 3GPP TS 23.501
		true: Supported
		false (default): Not Supported
		mpquicIp:
		@@ -2903,7 +2920,7 @@ components:
		default: false
		description: >
		Indicates the support of Access Traffic Steering, Switching and Splitting procedures
		using the MPQUIC-IP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
		using the MPQUIC-IP steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
		true: Supported
		false (default): Not Supported
		mpquicE:
		@@ -2911,7 +2928,7 @@ components:
		default: false
		description: >
		Indicates the support of Access Traffic Steering, Switching and Splitting procedures
		using the MPQUIC-E steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
		using the MPQUIC-E steering functionality (see clauses 4.2.10, 5.32 of 3GPP TS 23.501)
		true: Supported
		false (default): Not Supported
		PlmnIdNid:
		@@ -3121,7 +3138,7 @@ components:
		with the OpenAPI 'nullable: true' property.

		AcsInfo:
		description: The ACS information for the 5G-RG is defined in BBF TR-069 [42] or in BBF TR-369
		description: The ACS information for the 5G-RG is defined in BBF TR-069 [42] or in BBF TR-369
		type: object
		properties:
		acsUrl:
		@@ -3236,7 +3253,7 @@ components:
		type: string
		pattern: '^[0-9A-F]{20}$'
		description: >
		Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause
		Refers to Calling Geodetic Location. See ITU-T Recommendation Q.763 (1999) clause
		3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed
		to be used.

		@@ -3370,13 +3387,13 @@ components:
		type: object
		properties:
		ipv4Addr:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
		$ref: '#/components/schemas/Ipv4Addr'
		ipv6Addr:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
		$ref: '#/components/schemas/Ipv6Addr'
		portNumber:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		$ref: '#/components/schemas/Uinteger'
		macAddr:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48'
		$ref: '#/components/schemas/MacAddr48'

		MoExpDataCounter:
		description: Contain the MO Exception Data Counter.
		@@ -4025,7 +4042,6 @@ components:
		type: object
		required:
		- cagInfo
		- commonValidTimePeriodList
		properties:
		cagInfo:
		type: array
		@@ -4048,6 +4064,8 @@ components:
		$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ValidTimePeriod'
		minItems: 1
		minProperties: 1
		provisionOperation:
		$ref: '#/components/schemas/CagProvisionOperation'

		#
		# Data types describing alternative data types or combinations of data types
		@@ -4339,7 +4357,7 @@ components:
		type: integer
		minimum: 1
		description: >
		Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP
		Unsigned integer indicating Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP
		TS 23.501 [8])), expressed in 0.01 milliseconds.

		ExtPacketDelBudgetRm:
		@@ -4473,7 +4491,7 @@ components:
		- $ref: '#/components/schemas/NullValue'
		description: >
		The enumeration AdditionalQosFlowInfo provides additional QoS flow information (see clause
		9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table
		9.3.1.12 3GPP TS 38.413 [11]). It shall comply with the provisions defined in table
		5.5.3.12-1.

		PartitioningCriteria:
		@@ -4547,6 +4565,7 @@ components:
		enum:
		- PDU_SET_MARKING
		- DYN_CHANGING_TRAFFIC_CHAR
		- EXPEDITED_TRANSFER_IND
		- type: string
		description: >
		The enumeration indicates the type of Rtp Header Extension type
		@@ -4774,6 +4793,12 @@ components:
		$ref: '#/components/schemas/MediaTransportProtoRm'
		rtpHeaderExtInfo:
		$ref: '#/components/schemas/RtpHeaderExtInfoRm'
		addRtpHeaderExtInfo:
		type: array
		nullable: true
		items:
		$ref: '#/components/schemas/RtpHeaderExtInfo'
		minItems: 1
		rtpPayloadInfoList:
		type: array
		nullable: true
		@@ -5021,7 +5046,7 @@ components:
		description: >
		The enumeration MeasurementNrForMdt defines Measurements used for MDT in NR in the trace.
		See 3GPP TS 32.422 for further description of the values. It shall comply with the
		provisions defined in table 5.6.3.6-1.
		provisions defined in table 5.6.3.6-1.

		SensorMeasurement:
		anyOf:
		@@ -5278,7 +5303,7 @@ components:
		description: >
		The enumeration AvailableRanVisibleQoeMetric indicates different available
		RAN-visible QoE metrics to the gNB. It shall comply with the provisions defined
		in TS 29.571, table 5.6.3.22-1.
		in TS 29.571, table 5.6.3.22-1.
		anyOf:
		- type: string
		enum:
		@@ -6751,6 +6776,10 @@ components:
		type: string
		pattern: '^[A-Za-z0-9+/_-]{20,255}$'

		ImsTranspInfo:
		description: IMS object to carry transparent information for IMS Exposure services.
		type: object


		#
		# Enumerations
		@@ -6867,7 +6896,7 @@ components:
		- NET_CENTRIC_DCAS
		- type: string


		#
		# STRUCTURED DATA TYPES
		#
		DcEndpoint:
		@@ -7020,7 +7049,7 @@ components:
		type: object
		properties:
		reportMode:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsReportMode'
		$ref: '#/components/schemas/ImsReportMode'
		oneTimeReport:
		type: boolean
		oneTimeNotification:
		@@ -7028,9 +7057,9 @@ components:
		maxNumOfReports:
		type: integer
		reportPeriod:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		$ref: '#/components/schemas/DurationSec'
		expiry:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		$ref: '#/components/schemas/DateTime'

		ImsEventConfiguration:
		description: Ims event configuration information.
		@@ -7039,26 +7068,23 @@ components:
		- imsEvent
		properties:
		imsEvent:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEvent'
		$ref: '#/components/schemas/ImsEvent'
		eventInfo:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/EventInformation'
		$ref: '#/components/schemas/EventInformation'
		reqCurrentStatus:
		type: boolean
		imsEventFilters:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEventFilter'
		$ref: '#/components/schemas/ImsEventFilter'
		minItems: 1

		EventInformation:
		description: Ims event information.
		type: object
		properties:
		adcConfig:
		type: string
		bdcConfig:
		type: string

		imsTranspEventConfig:
		$ref: '#/components/schemas/ImsTranspInfo'
		ImsEventFilter:
		description: Conditions to match specific Ims event.
		type: object
		@@ -7070,9 +7096,11 @@ components:
		type: string
		pattern: '^(sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}\|tel\:\+[0-9]{5,15})$'
		appBindingInfo:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AppBindingInfo'
		$ref: '#/components/schemas/AppBindingInfo'
		sessionId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId'
		$ref: '#/components/schemas/SessionId'
		imsTranspFilter:
		$ref: '#/components/schemas/ImsTranspInfo'

		ImsEventReport:
		description: Ims event report.
		@@ -7081,20 +7109,22 @@ components:
		- imsEvent
		properties:
		imsEvent:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEvent'
		$ref: '#/components/schemas/ImsEvent'
		eventReport:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEventReportInfo'
		$ref: '#/components/schemas/ImsEventReportInfo'
		sessionId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId'
		$ref: '#/components/schemas/SessionId'

		ImsEventReportInfo:
		description: Ims event report specific information.
		type: object
		properties:
		adcReport:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AdcReport'
		$ref: '#/components/schemas/AdcReport'
		bdcReport:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BdcReport'
		$ref: '#/components/schemas/BdcReport'
		imsTranspEventReport:
		$ref: '#/components/schemas/ImsTranspInfo'

		AdcReport:
		description: Application data channel report.
		@@ -7103,7 +7133,7 @@ components:
		- adcStatus
		properties:
		adcStatus:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/AdcStatus'
		$ref: '#/components/schemas/AdcStatus'

		BdcReport:
		description: Bootstrap data channel report.
		@@ -7112,7 +7142,7 @@ components:
		- bdcStatus
		properties:
		bdcStatus:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BdcStatus'
		$ref: '#/components/schemas/BdcStatus'

		RcdProperties:
		description: Contains the RCD related parameters.
		@@ -7127,7 +7157,7 @@ components:

		RcdInformation:
		description: >
		Contains a collection of RCD properties as specified in draft-ietf-sipcore-callinfo-rcd
		Contains a collection of RCD properties as specified in IETF RFC 9796
		and represented as a jCard JSON object.
		type: object
		required:
		@@ -7350,9 +7380,10 @@ components:
		#
		#

		AiotAreaId:
		description: Ambient IoT Area identifier.
		AiotAreaCode:
		description: Ambient IoT Area code.
		type: string
		pattern: '^[A-Fa-f0-9]{6}$'

		AiotFilteringInformation:
		description: Ambient IoT Filtering Information.
		@@ -7360,8 +7391,7 @@ components:


		AiotDevPermId:
		type: string
		pattern: '^[A-Fa-f0-9]+$'
		$ref: '#/components/schemas/Bytes'
		description: >
		String identifying the AIoT Device Permanent Identifier.

		@@ -7382,6 +7412,21 @@ components:
		required:
		- areaIds

		AiotAreaId:
		description: AIoT Area ID.
		type: object
		properties:
		plmnId:
		$ref: '#/components/schemas/PlmnId'
		nid:
		$ref: '#/components/schemas/Nid'
		aiotAreaCode:
		$ref: '#/components/schemas/AiotAreaCode'
		required:
		- plmnId
		- aiotAreaCode



		#
		# HTTP responses
		@@ -7536,3 +7581,4 @@ components:
		$ref: '#/components/schemas/ProblemDetails'
		default:
		description: Generic Error