Replace TS28541_5GcNrm.yaml (4c01f9bf) · Commits · SA5 – Management & Orchestration and Charging / Management and Orchestration APIs

OpenAPI/TS28541_5GcNrm.yaml

+385 −16

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: 3GPP 5GC NRM
		version: 19.5.0
		version: 19.4.0
		description: >-
		OAS 3.0.1 specification of the 5GC NRM
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -192,6 +192,8 @@ components:
		default: false
		perPlmnOauth2ReqList:
		$ref: '#/components/schemas/PlmnOauth2'
		selectionConditions:
		$ref: '#/components/schemas/SelectionConditions'
		PlmnOauth2:
		description: Oauth2.0 required indication for a given PLMN ID
		type: object
		@@ -436,6 +438,10 @@ components:
		uniqueItems: true
		items:
		$ref: '#/components/schemas/PlmnSnssai'
		priority:
		type: integer
		minimum: 0
		maximum: 65535
		allowedSNPNs:
		type: array
		uniqueItems: true
		@@ -577,12 +583,64 @@ components:
		type: boolean
		default: false
		selectionConditions:
		description: >
		conditions under which an NF Instance shall be selected by an NF Service Consumer.
		type: array
		items:
		$ref: '#/components/schemas/SelectionConditions'
		minItems: 1

		2G3GLocationArea:
		description: 2G/3G Location Area.
		type: object
		properties:
		lai:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/LocationAreaId'
		rai:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/RoutingAreaId'
		2G3GLocationAreaRange:
		description: 2G/3G Location Area Range.
		type: object
		properties:
		laiRange:
		$ref: '#/components/schemas/LocationAreaIdRange'
		raiRange:
		$ref: '#/components/schemas/RoutingAreaIdRange'
		LocationAreaIdRange:
		description: Location Area ID Range.
		type: object
		required:
		- plmnId
		- startLac
		- endLac
		properties:
		plmnId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
		startLac:
		type: string
		pattern: '^[A-Fa-f0-9]{4}$'
		endLac:
		type: string
		pattern: '^[A-Fa-f0-9]{4}$'
		RoutingAreaIdRange:
		description: Routing Area ID Range.
		type: object
		required:
		- plmnId
		- startLac
		- endLac
		- startRac
		- endRac
		properties:
		plmnId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
		startLac:
		type: string
		pattern: '^[A-Fa-f0-9]{4}$'
		endLac:
		type: string
		pattern: '^[A-Fa-f0-9]{4}$'
		startRac:
		type: string
		pattern: '^[A-Fa-f0-9]{2}$'
		endRac:
		type: string
		pattern: '^[A-Fa-f0-9]{2}$'
		SelectionConditions:
		description: >
		It contains the set of conditions that shall be evaluated to determine whether a consumer
		@@ -813,6 +871,29 @@ components:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm'
		extMaxDataBurstVol:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm'
		pduSetQosDl:
		$ref: '#/components/schemas/PduSetQosPara'
		pduSetQosUl:
		$ref: '#/components/schemas/PduSetQosPara'

		PduSetQosPara:
		description: Represents the PDU Set level QoS parameters.
		type: object
		properties:
		pduSetDelayBudget:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtPacketDelBudget'
		pduSetErrRate:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
		pduSetHandlingInfo:
		anyOf:
		- type: string
		enum:
		- ALL_PDUS_NEEDED
		- ALL_PDUS_NOT_NEEDED
		- type: string
		anyOf:
		- required: [ pduSetDelayBudget, pduSetErrRate ]
		- required: [ pduSetHandlingInfo ]

		QosDataList:
		type: array
		@@ -879,6 +960,15 @@ components:
		$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MulticastAccessControl'
		snssaiList:
		$ref: '#/components/schemas/SnssaiList'
		l4sInd:
		anyOf:
		- type: string
		enum:
		- UL
		- DL
		- UL_DL
		- type: string


		TrafficControlDataList:
		type: array
		@@ -886,6 +976,76 @@ components:
		items:
		$ref: '#/components/schemas/TrafficControlData'

		QosMonitoringData:
		description: Contains QoS monitoring related control information.
		type: object
		properties:
		qmId:
		type: string
		description: Univocally identifies the QoS monitoring policy data within a PDU session.
		qosMonParamType:
		$ref: '#/components/schemas/QosMonitoringParamType'
		reqQosMonParams:
		type: array
		items:
		$ref: '#/components/schemas/RequestedQosMonitoringParameter'
		minItems: 1
		description: >
		Indicates the QoS information to be monitored when the QoS Monitoring is enabled for
		the service data flow.
		repFreqs:
		type: array
		items:
		$ref: '#/components/schemas/ReportingFrequency'
		minItems: 1
		description: >
		Indicates the frequency for the reporting, such as event triggered and/or periodic.
		repPeriod:
		type: integer

		QosMonitoringParamType:
		anyOf:
		- type: string
		enum:
		- PACKET_DELAY
		- CONGESTION
		- DATA_RATE
		- AVAILABLE_BITRATE
		- type: string
		description: \|
		Indicates the QoS monitoring parameter type.
		Possible values are:
		- PACKET_DELAY: Indicates that the QoS monitoring parameter to be measured is packet delay.
		- CONGESTION: Indicates that the QoS monitoring parameter to be measured is congestion.
		- DATA_RATE: Indicates that the QoS monitoring parameter to be measured is data rate.
		- AVAILABLE_BITRATE: Indicates that the QoS monitoring parameter to be measured is available
		bitrate.

		RequestedQosMonitoringParameter:
		description: Indicates the requested QoS monitoring parameters to be measured.
		anyOf:
		- type: string
		enum:
		- DOWNLINK
		- UPLINK
		- ROUND_TRIP
		- DOWNLINK_DATA_RATE
		- UPLINK_DATA_RATE
		- DOWNLINK_CONGESTION
		- UPLINK_CONGESTION
		- DOWNLINK_AVAILABLE_BITRATE
		- UPLINK_AVAILABLE_BITRATE
		- type: string

		ReportingFrequency:
		description: Indicates the frequency for the reporting.
		anyOf:
		- type: string
		enum:
		- EVENT_TRIGGERED
		- PERIODIC
		- type: string

		ServiceFeatureMap:
		type: object
		properties:
		@@ -960,6 +1120,79 @@ components:
		uniqueItems: true
		items:
		$ref: '#/components/schemas/ServiceFeatureMap'
		qosMonitoringData:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/QosMonitoringData'
		protoDescDl:
		$ref: '#/components/schemas/ProtocolDescription'
		protoDescUl:
		$ref: '#/components/schemas/ProtocolDescription'
		ProtocolDescription:
		type: object
		properties:
		transportProto:
		anyOf:
		- type: string
		enum:
		- RTP
		- SRTP
		- MOQT
		- type: string
		rtpHeaderExtInfo:
		$ref: '#/components/schemas/RtpHeaderExtInfo'
		addRtpHeaderExtInfo:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/RtpHeaderExtInfo'
		rtpPayloadInfoList:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/RtpPayloadInfo'
		mriTransferInfo:
		type: string
		RtpHeaderExtInfo:
		description: RTP Header Extension information
		type: object
		properties:
		rtpHeaderExtType:
		anyOf:
		- type: string
		enum:
		- PDU_SET_MARKING
		- DYN_CHANGING_TRAFFIC_CHAR
		- type: string
		rtpHeaderExtId:
		type: integer
		minimum: 1
		maximum: 255
		longFormat:
		type: boolean
		pduSetSizeActive:
		type: boolean
		pduSetPduCountActive:
		type: boolean
		RtpPayloadInfo:
		description: RtpPayloadInfo contains Rtp payload type and format.
		type: object
		properties:
		rtpPayloadTypeList:
		type: array
		items:
		type: integer
		minimum: 0
		maximum: 127
		minItems: 1
		rtpPayloadFormat:
		anyOf:
		- type: string
		enum:
		- H264
		- H265
		- type: string

		SnssaiInfo:
		type: object
		@@ -1547,6 +1780,18 @@ components:
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
		minItems: 1
		vflCapabilityType:
		type: string
		enum:
		- VFL_SERVER
		- VFL_CLIENT
		- VFL_SERVER_AND_CLIENT
		vflTimeInterval:
		type: array
		uniqueItems: true
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
		minItems: 1
		NwdafInfo:
		description: Information of a NWDAF NF Instance
		type: object
		@@ -1739,6 +1984,14 @@ components:
		type: string
		minItems: 1
		readOnly: true
		taiList:
		$ref: '#/components/schemas/TaiList'
		taiRangeList:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/TaiRange'
		minItems: 1
		UnTrustAfInfo:
		description: Information of a untrusted AF Instance
		type: object
		@@ -1755,6 +2008,21 @@ components:
		mappingInd:
		type: boolean
		default: false

		taiList:
		type: array
		uniqueItems: true
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
		minItems: 1
		taiRangeList:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/TaiRange'
		minItems: 1
		vflInfo:
		$ref: '#/components/schemas/VflInfo'
		SnssaiInfoItem:
		description: >
		Parameters supported by an NF for a given S-NSSAI Set of parameters supported by NF
		@@ -1883,6 +2151,14 @@ components:
		mappingInd:
		type: boolean
		default: false
		taiList:
		$ref: '#/components/schemas/TaiList'
		taiRangeList:
		type: array
		uniqueItems: true
		items:
		$ref: '#/components/schemas/TaiRange'
		minItems: 1
		ExternalClientType:
		description: Indicates types of External Clients.
		anyOf:
		@@ -2250,6 +2526,17 @@ components:
		default: false
		highLatencyCom:
		type: boolean
		amfEvents:
		type: array
		items:
		type: string
		minItems: 1
		praIdList:
		type: array
		items:
		type: string
		minItems: 1


		SmfInfo:
		description: Information of an SMF NF Instance
		@@ -2392,12 +2679,43 @@ components:
		supportedPfcpFeatures:
		type: string
		readOnly: true
		# upfEvents:
		# type: array
		uniqueItems: true
		# items:
		# $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType'
		# minItems: 1
		upfEvents:
		type: array
		uniqueItems: true
		items:
		type: string
		minItems: 1
		2g3gLocationAreaList:
		type: array
		items:
		$ref: '#/components/schemas/2G3GLocationArea'
		minItems: 1
		2g3gLocationAreaRangeList:
		type: array
		items:
		$ref: '#/components/schemas/2G3GLocationAreaRange'
		minItems: 1
		preferredEpdgInfoList:
		type: array
		items:
		$ref: '#/components/schemas/IpInterface'
		minItems: 1
		preferredWAgfInfoList:
		type: array
		items:
		$ref: '#/components/schemas/IpInterface'
		minItems: 1
		preferredTngfInfoList:
		type: array
		items:
		$ref: '#/components/schemas/IpInterface'
		minItems: 1
		preferredTwifInfoList:
		type: array
		items:
		$ref: '#/components/schemas/IpInterface'
		minItems: 1

		PcfInfo:
		description: Information of a PCF NF Instance
		@@ -3115,7 +3433,9 @@ components:
		type: object
		required:
		- sNssai
		- dnnInfoList
		anyOf:
		- required: [ dnnUpfInfoList ]
		- required: [ dnnUpfInfoListId ]
		properties:
		sNssai:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
		@@ -3484,6 +3804,13 @@ components:
		redundantTransport:
		type: boolean
		default: false
		interfaceUpfInfoList:
		type: array
		items:
		$ref: '#/components/schemas/InterfaceUpfInfoItem'
		minItems: 1
		dnnUpfInfoListId:
		type: integer
		IpIndex:
		description: Represents the IP Index to be sent from UDM to the SMF (its value can be either an integer or a string)
		anyOf:
		@@ -3550,6 +3877,23 @@ components:
		additionalProperties:
		type: string
		minProperties: 1
		interfaceUpfInfoList:
		type: array
		items:
		$ref: '#/components/schemas/InterfaceUpfInfoItem'
		minItems: 1
		privateIpv4AddressRangesPerIpDomain:
		description: >
		Map of private IPv4 Address Ranges Per Ip Domain, where the key of the map is the IP.
		Domain. When present, the value of each entry of the map shall contain a IPv4 private
		address ranges configured for that IP domain.
		type: object
		additionalProperties:
		type: array
		items:
		$ref: '#/components/schemas/Ipv4AddressRange'
		minItems: 1
		minProperties: 1
		not:
		required: [ networkInstance, dnaiNwInstanceList ]
		MnpfInfo:
		@@ -3843,10 +4187,35 @@ components:
		type: array
		uniqueItems: true
		items:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/ServedAIOTAreaID'
		type: string
		#$ref: 'TS28541_NrNrm.yaml#/components/schemas/ServedAIOTAreaID'
		readerLocation:
		type: string

		VflInfo:
		description: Indicates the Vfl capability supported by the NWDAF/TrustAF/unTrustAF
		type: object
		properties:
		vflAnalyticsIds:
		type: array
		uniqueItems: true
		items:
		$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
		minItems: 1
		vflCapabilityType:
		type: string
		enum:
		- VFL_SERVER
		- VFL_CLIENT
		- VFL_SERVER_AND_CLIENT
		vflClientAggrCap:
		type: boolean
		default: false
		vflTimeInterval:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
		vflInterInfo:
		$ref: '#/components/schemas/VendorId'
		featureId:
		type: string

		#-------- Definition of types for name-containments ------
		SubNetwork-ncO-5GcNrm: