Extracted OpenAPI definitions from Rel-17 TSs published after SA89 in September 2020 (0cec86c8) · Commits · Miguel Angel Reina Ortega / Management and Orchestration APIs

OpenAPI/5gcNrm.yaml

+184 −6

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: 3GPP 5GC NRM
		version: 16.5.0
		version: 16.6.0
		description: >-
		OAS 3.0.1 specification of the 5GC NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.541 V16.4.0; 5G NRM, 5GC NRM
		description: 3GPP TS 28.541 V16.6.0; 5G NRM, 5GC NRM
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/
		paths: {}
		components:
		@@ -298,7 +298,138 @@ components:
		thresholdRtt:
		type: integer


		QosData:
		type: object
		properties:
		qosId:
		type: string
		fiveQIValue:
		type: integer
		maxbrUl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		maxbrDl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		gbrUl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		gbrDl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/BitRateRm'
		arp:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/Arp'
		qosNotificationControl:
		type: boolean
		reflectiveQos:
		type: boolean
		sharingKeyDl:
		type: string
		sharingKeyUl:
		type: string
		maxPacketLossRateDl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm'
		maxPacketLossRateUl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm'
		extMaxDataBurstVol:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm'
		QosDataList:
		type: array
		items:
		$ref: '#/components/schemas/QosData'
		SteeringMode:
		type: object
		properties:
		steerModeValue:
		$ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue'
		active:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/AccessType'
		standby:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/AccessTypeRm'
		threeGLoad:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/Uinteger'
		prioAcc:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/AccessType'
		TrafficControlData:
		type: object
		properties:
		tcId:
		type: string
		flowStatus:
		$ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus'
		redirectInfo:
		$ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation'
		addRedirectInfo:
		type: array
		items:
		$ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation'
		minItems: 1
		muteNotif:
		type: boolean
		trafficSteeringPolIdDl:
		type: string
		nullable: true
		trafficSteeringPolIdUl:
		type: string
		nullable: true
		routeToLocs:
		type: array
		items:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/RouteToLocation'
		traffCorreInd:
		type: boolean
		upPathChgEvent:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/UpPathChgEvent'
		steerFun:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/SteeringFunctionality'
		steerModeDl:
		$ref: '#/components/schemas/SteeringMode'
		steerModeUl:
		$ref: '#/components/schemas/SteeringMode'
		mulAccCtrl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/MulticastAccessControl'
		TrafficControlDataList:
		type: array
		items:
		$ref: '#/components/schemas/TrafficControlData'
		PccRule:
		type: object
		properties:
		pccRuleId:
		type: string
		description: Univocally identifies the PCC rule within a PDU session.
		flowInfoList:
		type: array
		items:
		$ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation'
		applicationId:
		type: string
		appDescriptor:
		$ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor'
		contentVersion:
		$ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion'
		precedence:
		$ref: '/rep/all/5G_APIs/raw/master/TS29571_CommonData.yaml#/components/schemas/Uinteger'
		afSigProtocol:
		$ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol'
		isAppRelocatable:
		type: boolean
		isUeAddrPreserved:
		type: boolean
		qosData:
		type: array
		items:
		$ref: '#/components/schemas/QosDataList'
		altQosParams:
		type: array
		items:
		$ref: '#/components/schemas/QosDataList'
		trafficControlData:
		type: array
		items:
		$ref: '#/components/schemas/TrafficControlDataList'
		conditionData:
		$ref: '/rep/all/5G_APIs/raw/master/TS29512_Npcf_SMPolicyControl#/components/schemas/ConditionData'
		tscaiInputDl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
		tscaiInputUl:
		$ref: '/rep/all/5G_APIs/raw/master/TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer'
		#-------- Definition of concrete IOCs --------------------------------------------

		SubNetwork-Single:
		@@ -328,6 +459,8 @@ components:
		$ref: '#/components/schemas/AmfRegion-Multiple'
		Configurable5QISet:
		$ref: '#/components/schemas/Configurable5QISet-Multiple'
		Dynamic5QISet:
		$ref: '#/components/schemas/Dynamic5QISet-Multiple'

		ManagedElement-Single:
		allOf:
		@@ -378,7 +511,8 @@ components:
		$ref: '#/components/schemas/NefFunction-Multiple'
		Configurable5QISet:
		$ref: '#/components/schemas/Configurable5QISet-Multiple'

		Dynamic5QISet:
		$ref: '#/components/schemas/Dynamic5QISet-Multiple'
		AmfFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		@@ -490,7 +624,9 @@ components:
		$ref: '#/components/schemas/ManagedNFProfile'
		commModelList:
		$ref: '#/components/schemas/CommModelList'
		Configurable5QISetRef:
		configurable5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		dynamic5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'

		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		@@ -514,6 +650,8 @@ components:
		$ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single'
		QFQoSMonitoringControl:
		$ref: '#/components/schemas/QFQoSMonitoringControl-Single'
		PredefinedPccRuleSet:
		$ref: '#/components/schemas/PredefinedPccRuleSet-Single'

		UpfFunction-Single:
		allOf:
		@@ -589,6 +727,10 @@ components:
		$ref: '#/components/schemas/ManagedNFProfile'
		commModelList:
		$ref: '#/components/schemas/CommModelList'
		configurable5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		dynamic5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:
		@@ -602,6 +744,8 @@ components:
		$ref: '#/components/schemas/EP_N16-Multiple'
		EP_Rx:
		$ref: '#/components/schemas/EP_Rx-Multiple'
		PredefinedPccRuleSet:
		$ref: '#/components/schemas/PredefinedPccRuleSet-Single'
		AusfFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		@@ -987,6 +1131,8 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/LocalAddress'
		remoteAddress:
		$ref: 'nrNrm.yaml#/components/schemas/RemoteAddress'
		epTransportRefs:
		$ref: 'genericNrm.yaml#/components/schemas/DnList'
		EP_N4-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		@@ -1407,6 +1553,19 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/FiveQICharacteristics'
		Dynamic5QISet-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		dynamic5QIs:
		type: array
		items:
		$ref: '#/components/schemas/FiveQICharacteristics'
		GtpUPathQoSMonitoringControl-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		@@ -1481,6 +1640,19 @@ components:
		qFMeasurementPeriod:
		type: integer

		PredefinedPccRuleSet-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		predefinedPccRules:
		type: array
		items:
		$ref: '#/components/schemas/PccRule'

		#-------- Definition of JSON arrays for name-contained IOCs ----------------------

		@@ -1715,6 +1887,10 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/Configurable5QISet-Single'
		Dynamic5QISet-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/Dynamic5QISet-Single'


		#------------ Definitions in TS 28.541 for TS 28.532 -----------------------------
		@@ -1787,3 +1963,5 @@ components:
		- $ref: '#/components/schemas/EP_NLG-Single'
		- $ref: '#/components/schemas/Configurable5QISet-Single'
		- $ref: '#/components/schemas/FiveQiDscpMappingSet-Single'
		- $ref: '#/components/schemas/PredefinedPccRuleSet-Single'
		- $ref: '#/components/schemas/Dynamic5QISet-Single'

OpenAPI/nrNrm.yaml

+127 −32

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: NR NRM
		version: 16.5.0
		version: 16.6.0
		description: >-
		OAS 3.0.1 specification of the NR NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.541 V16.5.0; 5G NRM, NR NRM
		description: 3GPP TS 28.541 V16.6.0; 5G NRM, NR NRM
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/
		paths: {}
		components:
		@@ -73,16 +73,22 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/PlmnInfo'
		GGnbId:
		type: string
		pattern: '^[0-9]{3}[0-9]{2,3}-(22\|23\|24\|25\|26\|27\|28\|29\|30\|31\|32)-[0-9]{1,10}'
		GEnbId:
		type: string
		pattern: '^[0-9]{3}[0-9]{2,3}-(18\|20\|21\|22)-[0-9]{1,7}'

		GGnbIdList:
		type: array
		items: string
		pattern: '^[0-9]{3}[0-9]{2,3}-(22\|23\|24\|25\|26\|27\|28\|29\|30\|31\|32)-[0-9]{1,10}'
		items:
		$ref: '#/components/schemas/GGnbId'

		GEnbIdList:
		type: array
		items: string
		pattern: '^[0-9]{3}[0-9]{2,3}-(18\|20\|21\|22)-[0-9]{1,7}'
		items:
		$ref: '#/components/schemas/GEnbId'

		NrPci:
		type: integer
		@@ -262,8 +268,7 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/RrmPolicyMember'

		LocalAddress:
		AddressWithVlan:
		type: object
		properties:
		ipv4Address:
		@@ -274,6 +279,11 @@ components:
		type: integer
		minimum: 0
		maximum: 4096
		LocalAddress:
		type: object
		properties:
		addressWithVlan:
		$ref: '#/components/schemas/AddressWithVlan'
		port:
		type: integer
		minimum: 0
		@@ -541,6 +551,21 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/RimRSReportInfo'
		TceMappingInfo:
		type: object
		properties:
		TceIPAddress:
		oneOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr'
		- $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr'
		TceID:
		type: integer
		PlmnTarget:
		$ref: '#/components/schemas/PlmnId'
		TceMappingInfoList:
		type: array
		items:
		$ref: '#/components/schemas/TceMappingInfo'

		#-------- Definition of abstract IOCs --------------------------------------------

		@@ -593,6 +618,9 @@ components:
		$ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple'
		RimRSGlobal:
		$ref: '#/components/schemas/RimRSGlobal-Single'
		Dynamic5QISet:
		$ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple'

		ManagedElement-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		@@ -623,6 +651,8 @@ components:
		$ref: '#/components/schemas/CESManagementFunction-Single'
		Configurable5QISet:
		$ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple'
		Dynamic5QISet:
		$ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple'

		GnbDuFunction-Single:
		allOf:
		@@ -679,6 +709,8 @@ components:
		$ref: '#/components/schemas/PlmnInfoList'
		configurable5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		dynamic5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		- $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:
		@@ -728,8 +760,12 @@ components:
		$ref: '#/components/schemas/GEnbIdList'
		mappingSetIDBackhaulAddress:
		$ref: '#/components/schemas/MappingSetIDBackhaulAddress'
		tceMappingInfoList:
		$ref: '#/components/schemas/TceMappingInfoList'
		configurable5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		dynamic5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		- $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:
		@@ -874,9 +910,7 @@ components:
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		type: object
		properties:
		absoluteFrequencySSB:
		type: integer
		@@ -888,15 +922,22 @@ components:
		type: integer
		minimum: 1
		maximum: 256
		- $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO'
		EUtranFrequency-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		- type: object
		properties:
		attributes:
		$ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr'
		- $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO'
		type: object
		properties:
		earfcnDL:
		type: integer
		minimum: 0
		maximum: 262143
		multiBandInfoListEutra:
		type: integer
		minimum: 1
		maximum: 256

		NrSectorCarrier-Single:
		allOf:
		@@ -1041,6 +1082,8 @@ components:
		$ref: '#/components/schemas/IsESCoveredBy'
		isENDCAllowed:
		type: boolean
		isMLBAllowed:
		type: boolean
		EUtranCellRelation-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		@@ -1123,13 +1166,63 @@ components:
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		type: object
		properties:
		cellIndividualOffset:
		$ref: '#/components/schemas/CellIndividualOffset'
		blackListEntry:
		type: array
		items:
		type: integer
		minimum: 0
		maximum: 1007
		blackListEntryIdleMode:
		type: integer
		cellReselectionPriority:
		type: integer
		cellReselectionSubPriority:
		type: number
		minimum: 0.2
		maximum: 0.8
		multipleOf: 0.2
		pMax:
		type: integer
		minimum: -30
		maximum: 33
		qOffsetFreq:
		$ref: '#/components/schemas/QOffsetFreq'
		qQualMin:
		type: number
		qRxLevMin:
		type: integer
		minimum: -140
		maximum: -44
		threshXHighP:
		type: integer
		minimum: 0
		maximum: 62
		threshXHighQ:
		type: integer
		minimum: 0
		maximum: 31
		threshXLowP:
		type: integer
		minimum: 0
		maximum: 62
		threshXLowQ:
		type: integer
		minimum: 0
		maximum: 31
		tReselectionEutran:
		type: integer
		minimum: 0
		maximum: 7
		tReselectionNRSfHigh:
		$ref: '#/components/schemas/TReselectionNRSf'
		tReselectionNRSfMedium:
		$ref: '#/components/schemas/TReselectionNRSf'
		eUTranFrequencyRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'
		- $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO'
		DANRManagementFunction-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		@@ -1538,6 +1631,8 @@ components:
		$ref: '#/components/schemas/LocalAddress'
		remoteAddress:
		$ref: '#/components/schemas/RemoteAddress'
		epTransportRefs:
		$ref: 'genericNrm.yaml#/components/schemas/DnList'
		EP_X2U-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'

OpenAPI/sliceNrm.yaml

+61 −10

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Slice NRM
		version: 16.4.0
		version: 16.5.0
		description: >-
		OAS 3.0.1 specification of the Slice NRM
		@ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -30,6 +30,48 @@ components:
		enum:
		- SHARED
		- NON-SHARED
		PerfReqEmbb:
		type: object
		properties:
		expDataRateDL:
		type: number
		expDataRateUL:
		type: number
		areaTrafficCapDL:
		type: number
		areaTrafficCapUL:
		type: number
		userDensity:
		type: number
		activityFactor:
		type: number
		PerfReqEmbbList:
		type: array
		items:
		$ref: '#/components/schemas/PerfReqEmbb'
		PerfReqUrllc:
		type: object
		properties:
		cSAvailabilityTarget:
		type: number
		cSReliabilityMeanTime:
		type: string
		expDataRate:
		type: number
		msgSizeByte:
		type: string
		transferIntervalTarget:
		type: string
		survivalTime:
		type: string
		PerfReqUrllcList:
		type: array
		items:
		$ref: '#/components/schemas/PerfReqUrllc'
		PerfReq:
		oneOf:
		- $ref: '#/components/schemas/PerfReqEmbbList'
		- $ref: '#/components/schemas/PerfReqUrllcList'
		Category:
		type: string
		enum:
		@@ -119,12 +161,12 @@ components:
		$ref: '#/components/schemas/ServAttrCom'
		maxsize:
		type: integer
		MaxNumberofConns:
		MaxNumberofPDUSessions:
		type: object
		properties:
		servAttrCom:
		$ref: '#/components/schemas/ServAttrCom'
		nOofConn:
		nOofPDUSessions:
		type: integer
		KPIMonitoring:
		type: object
		@@ -133,13 +175,13 @@ components:
		$ref: '#/components/schemas/ServAttrCom'
		kPIList:
		type: string
		SupportedAccessTech:
		NBIoT:
		type: object
		properties:
		servAttrCom:
		$ref: '#/components/schemas/ServAttrCom'
		accTechList:
		type: integer
		support:
		$ref: '#/components/schemas/Support'
		UserMgmtOpen:
		type: object
		properties:
		@@ -203,12 +245,12 @@ components:
		$ref: '#/components/schemas/ULThptPerUE'
		maxPktSize:
		$ref: '#/components/schemas/MaxPktSize'
		maxNumberofConns:
		$ref: '#/components/schemas/MaxNumberofConns'
		maxNumberofPDUSessions:
		$ref: '#/components/schemas/MaxNumberofPDUSessions'
		kPIMonitoring:
		$ref: '#/components/schemas/KPIMonitoring'
		supportedAccessTech:
		$ref: '#/components/schemas/SupportedAccessTech'
		nBIoT:
		$ref: '#/components/schemas/NBIoT'
		userMgmtOpen:
		$ref: '#/components/schemas/UserMgmtOpen'
		v2XModels:
		@@ -227,6 +269,10 @@ components:
		type: string
		reliability:
		type: string
		maxDLDataVolume:
		type: string
		maxULDataVolume:
		type: string
		SliceProfileList:
		type: object
		additionalProperties:
		@@ -236,6 +282,8 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/SnssaiList'
		plmnIdList:
		$ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
		perfReq:
		$ref: '#/components/schemas/PerfReq'
		maxNumberofUEs:
		type: number
		coverageAreaTAList:
		@@ -314,6 +362,8 @@ components:
		type: string
		qosProfile:
		type: string
		epApplicationRefs:
		$ref: 'genericNrm.yaml#/components/schemas/DnList'

		EP_Transport-Multiple:
		type: array
		@@ -326,3 +376,4 @@ components:
		oneOf:
		- $ref: '#/components/schemas/NetworkSlice'
		- $ref: '#/components/schemas/NetworkSliceSubnet'
		- $ref: '#/components/schemas/EP_Transport-Single'