Merge branch 'Integration_Rel17_SA5_141_YAML' into 'Rel17-draft' (3b112a6c) · Commits · Miguel Angel Reina Ortega / Management and Orchestration APIs

OpenAPI/5gcNrm.yaml

+163 −19

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: 3GPP 5GC NRM
		version: 17.5.0
		version: 17.6.0
		description: >-
		OAS 3.0.1 specification of the 5GC NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -563,6 +563,63 @@ components:
		items:
		type: string

		DnnSmfInfoItem:
		type: object
		properties:
		dnn:
		type: string
		dnaiList:
		type: array
		items:
		type: string

		SNssaiSmfInfoItem:
		type: object
		properties:
		sNSSAI:
		$ref: 'nrNrm.yaml#/components/schemas/Snssai'
		dnnSmfInfoList:
		type: array
		items:
		$ref: '#/components/schemas/DnnSmfInfoItem'

		IpAddr:
		type: object
		properties:
		ipv4Addr:
		type: string
		ipv6Addr:
		type: string
		ipv6Prefix:
		type: string

		5GCNfConnEcmInfoList:
		type: array
		items:
		$ref: '#/components/schemas/5GCNfConnEcmInfo'
		5GCNfConnEcmInfo:
		type: object
		description: 'Store the 5GC NF connection information'
		properties:
		5GCNFType:
		type: string
		enum:
		- PCF
		- NEF
		- SCEF
		5GCNFIpAddress:
		type: string
		5GCNFRef:
		$ref: 'comDefs.yaml#/components/schemas/Dn'

		UPFConnectionInfo:
		type: object
		properties:
		uPFIpAddress:
		type: string
		uPFRef:
		$ref: 'comDefs.yaml#/components/schemas/Dn'

		#-------- Definition of concrete IOCs --------------------------------------------

		SubNetwork-Single:
		@@ -594,6 +651,8 @@ components:
		$ref: '#/components/schemas/Configurable5QISet-Multiple'
		Dynamic5QISet:
		$ref: '#/components/schemas/Dynamic5QISet-Multiple'
		EcmConnectionInfo:
		$ref: '#/components/schemas/EcmConnectionInfo-Multiple'

		ManagedElement-Single:
		allOf:
		@@ -646,6 +705,8 @@ components:
		$ref: '#/components/schemas/Configurable5QISet-Multiple'
		Dynamic5QISet:
		$ref: '#/components/schemas/Dynamic5QISet-Multiple'
		EcmConnectionInfo:
		$ref: '#/components/schemas/EcmConnectionInfo-Multiple'

		AmfFunction-Single:
		allOf:
		@@ -666,8 +727,10 @@ components:
		interPlmnFQDN:
		type: string
		taiList:
		$ref: 'nrNrm.yaml#/components/schemas/Tai'
		$ref: 'nrNrm.yaml#/components/schemas/TaiList'
		taiRangeList:
		type: array
		items:
		$ref: 'nrNrm.yaml#/components/schemas/TaiRange'
		weightFactor:
		$ref: '#/components/schemas/WeightFactor'
		@@ -676,10 +739,16 @@ components:
		cNSIIdList:
		$ref: '#/components/schemas/CNSIIdList'
		gUAMIdList:
		type: array
		items:
		$ref: '#/components/schemas/GUAMInfo'
		backupInfoAmfFailure:
		type: array
		items:
		$ref: '#/components/schemas/GUAMInfo'
		backupInfoAmfRemoval:
		type: array
		items:
		$ref: '#/components/schemas/GUAMInfo'
		amfSetRef:
		$ref: 'comDefs.yaml#/components/schemas/Dn'
		@@ -766,14 +835,42 @@ components:
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		plmnIdList:
		$ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
		pLMNInfoList:
		$ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList'
		nRTACList:
		$ref: '#/components/schemas/TACList'
		sBIFqdn:
		type: string
		snssaiList:
		$ref: 'nrNrm.yaml#/components/schemas/SnssaiList'
		sNssaiSmfInfoList:
		type: array
		items:
		$ref: '#/components/schemas/SNssaiSmfInfoItem'
		taiList:
		type: array
		items:
		$ref: 'nrNrm.yaml#/components/schemas/Tai'
		taiRangeList:
		type: array
		items:
		$ref: 'nrNrm.yaml#/components/schemas/TaiRange'
		pwgFqdn:
		type: string
		pgwAddrList:
		type: array
		items:
		$ref: '#/components/schemas/IpAddr'
		accessType:
		$ref: 'https://forge.3gpp.org/rep/all/5G_APIs/raw/REL-16/TS29571_CommonData.yaml#/components/schemas/AccessType'
		priority:
		type: integer
		cNSIIdList:
		$ref: '#/components/schemas/CNSIIdList'
		vsmfSupportInd:
		type: boolean
		pwgFqdnList:
		type: array
		items:
		type: string
		managedNFProfile:
		$ref: '#/components/schemas/ManagedNFProfile'
		commModelList:
		@@ -1248,7 +1345,7 @@ components:

		DDNMFFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		@@ -1300,6 +1397,40 @@ components:
		EP_Nxx:
		$ref: '#/components/schemas/EP_Nxx-Multiple'

		EcmConnectionInfo-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		eASServiceArea:
		$ref: 'EdgeNRM.yaml#/components/schemas/ServingLocation'
		eESServiceArea:
		$ref: 'EdgeNRM.yaml#/components/schemas/ServingLocation'
		eDNServiceArea:
		$ref: 'EdgeNRM.yaml#/components/schemas/ServingLocation'
		eASIpAddress:
		type: string
		eESIpAddress:
		type: string
		eCSIpAddress:
		type: string
		ednIdentifier:
		type: string
		ecmConnectionType:
		type: string
		enum:
		- USERPLANE
		- CONTROLPLANE
		- BOTH
		5GCNfConnEcmInfoList:
		$ref: '#/components/schemas/5GCNfConnEcmInfoList'
		uPFConnectionInfo:
		$ref: '#/components/schemas/UPFConnectionInfo'


		ExternalAmfFunction-Single:
		allOf:
		@@ -1696,7 +1827,7 @@ components:
		type: boolean
		EP_N33-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		@@ -1809,7 +1940,7 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/RemoteAddress'
		EP_Npc4-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		@@ -1823,7 +1954,7 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/RemoteAddress'
		EP_Npc6-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		@@ -1837,7 +1968,7 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/RemoteAddress'
		EP_Npc7-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		@@ -1851,7 +1982,7 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/RemoteAddress'
		EP_Npc8-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		@@ -1895,7 +2026,7 @@ components:

		FiveQICharacteristics-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		fiveQIValue:
		@@ -2304,6 +2435,11 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/Dynamic5QISet-Single'
		EcmConnectionInfo-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EcmConnectionInfo-Single'




		@@ -2332,6 +2468,7 @@ components:
		- $ref: '#/components/schemas/ScpFunction-Single'
		- $ref: '#/components/schemas/NefFunction-Single'
		- $ref: '#/components/schemas/NsacfFunction-Single'
		- $ref: '#/components/schemas/DDNMFFunction-Single'

		- $ref: '#/components/schemas/ExternalAmfFunction-Single'
		- $ref: '#/components/schemas/ExternalNrfFunction-Single'
		@@ -2373,6 +2510,11 @@ components:
		- $ref: '#/components/schemas/EP_N60-Single'
		- $ref: '#/components/schemas/EP_Nxx-Single'

		- $ref: '#/components/schemas/EP_Npc4-Single'
		- $ref: '#/components/schemas/EP_Npc6-Single'
		- $ref: '#/components/schemas/EP_Npc7-Single'
		- $ref: '#/components/schemas/EP_Npc8-Single'

		- $ref: '#/components/schemas/EP_S5C-Single'
		- $ref: '#/components/schemas/EP_S5U-Single'
		- $ref: '#/components/schemas/EP_Rx-Single'
		@@ -2384,3 +2526,5 @@ components:
		- $ref: '#/components/schemas/PredefinedPccRuleSet-Single'
		- $ref: '#/components/schemas/Dynamic5QISet-Single'
		- $ref: '#/components/schemas/EASDFFunction-Single'
		- $ref: '#/components/schemas/EcmConnectionInfo-Single'

OpenAPI/EdgeNRM.yaml

0 → 100644

+228 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: 3GPP Edge NRM
		version: 17.0.0
		description: >-
		OAS 3.0.1 specification of the Edge NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.538; Edge NRM
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.538/
		paths: {}
		components:
		schemas:

		#-------- Definition of types-----------------------------------------------------
		ServingLocation:
		type: object
		properties:
		geographicalLocation:
		$ref: '#/components/schemas/GeoLoc'
		topologicalLocation:
		$ref: '#/components/schemas/TopologicalServiceArea'
		TopologicalServiceArea:
		type: object
		properties:
		cellIdList:
		type: integer
		trackingAreaIdList:
		$ref: 'nrNrm.yaml#/components/schemas/Tai'
		servingPLMN:
		$ref: 'nrNrm.yaml#/components/schemas/PlmnId'
		GeoLoc:
		type: object
		properties:
		geographicalCoordinates:
		$ref: '#/components/schemas/GeographicalCoordinates'
		civicLocation:
		type: string
		GeographicalCoordinates:
		type: object
		properties:
		lattitude:
		type: integer
		longitude:
		type: integer
		EDNConnectionInfo:
		type: object
		properties:
		dNN:
		type: string
		eDNServiceArea:
		$ref: '#/components/schemas/ServingLocation'
		AffinityAntiAffinity:
		type: object
		properties:
		affinityEAS:
		type: string
		antiAffinityEAS:
		type: string
		VirtualResource:
		type: object
		properties:
		virtualMemory:
		type: integer
		virtualDisk:
		type: integer
		SoftwareImageInfo:
		type: object
		properties:
		minimumDisk:
		type: integer
		minimumRAM:
		type: integer
		swImageRef:
		type: string


		#-------- Definition of concrete IOCs --------------------------------------------

		SubNetwork-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
		- type: object
		properties:
		Subnetwork:
		$ref: '#/components/schemas/SubNetwork-Multiple'
		ECSFunction:
		$ref: '#/components/schemas/ECSFunction-Multiple'
		EdgeDataNetwork:
		$ref: '#/components/schemas/EdgeDataNetwork-Multiple'
		- $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO'

		EdgeDataNetwork-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		ednIdentifier:
		type: string
		eDNConnectionInfo:
		$ref: '#/components/schemas/EDNConnectionInfo'
		- type: object
		properties:
		EASFunction:
		$ref: '#/components/schemas/EASFunction-Multiple'
		EESFunction:
		$ref: '#/components/schemas/EESFunction-Multiple'

		EASFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		eASIdentifier:
		type: string
		eESAddress:
		type: string
		eASRequirementsRef:
		$ref: 'comDefs.yaml#/components/schemas/Dn'
		eASAddress:
		type: string
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		EESFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		eESIdentifier:
		type: string
		eESServingLocation:
		$ref: '#/components/schemas/ServingLocation'
		eESAddress:
		type: string
		softwareImageInfo:
		$ref: '#/components/schemas/SoftwareImageInfo'
		serviceContinuitySupport:
		type: boolean
		eASFunctonRef:
		$ref: 'comDefs.yaml#/components/schemas/DnList'
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'

		ECSFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		eCSAddress:
		type: string
		providerIdentifier:
		type: string
		edgeDataNetworkRef:
		$ref: 'comDefs.yaml#/components/schemas/DnList'
		eESFuncitonRef:
		$ref: 'comDefs.yaml#/components/schemas/Dn'
		softwareImageInfo:
		$ref: '#/components/schemas/SoftwareImageInfo'
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'

		EASRequirements-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		requiredEASservingLocation:
		$ref: '#/components/schemas/ServingLocation'
		affinityAntiAffinity:
		$ref: '#/components/schemas/AffinityAntiAffinity'
		serviceContinuity:
		type: boolean
		virtualResource:
		$ref: '#/components/schemas/VirtualResource'
		softwareImageInfo:
		$ref: '#/components/schemas/SoftwareImageInfo'

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

		SubNetwork-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/SubNetwork-Single'
		EASFunction-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EASFunction-Single'
		ECSFunction-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/ECSFunction-Single'
		EESFunction-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EESFunction-Single'
		EdgeDataNetwork-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/EdgeDataNetwork-Single'

		#--------------------------------- Definition ------------------------------------

		resources-edgeNrm:
		oneOf:
		- $ref: '#/components/schemas/SubNetwork-Single'
		- $ref: '#/components/schemas/EASFunction-Single'
		- $ref: '#/components/schemas/ECSFunction-Single'
		- $ref: '#/components/schemas/EESFunction-Single'
		- $ref: '#/components/schemas/EdgeDataNetwork-Single'
		- $ref: '#/components/schemas/EASRequirements-Single'

OpenAPI/genericNrm.yaml

+189 −4

File changed.

Preview size limit exceeded, changes collapsed.

OpenAPI/intentNrm.yaml

0 → 100644

+383 −0

File added.

Preview size limit exceeded, changes collapsed.

OpenAPI/nrNrm.yaml

+81 −5

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: NR NRM
		version: 17.5.0
		version: 17.6.0
		description: >-
		OAS 3.0.1 specification of the NR NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -260,6 +260,16 @@ components:
		minimum: -20
		maximum: 20

		MaximumDeviationHoTriggerLow:
		type: integer
		minimum: -20
		maximum: 20

		MaximumDeviationHoTriggerHigh:
		type: integer
		minimum: -20
		maximum: 20

		MinimumTimeBetweenHoTriggerChange:
		type: integer
		minimum: 0
		@@ -629,7 +639,13 @@ components:
		- PRB_DL
		- RRC
		- DRB

		ParameterRange:
		type: object
		properties:
		maxValue:
		type: integer
		minValue:
		type: integer
		#-------- Definition of abstract IOCs --------------------------------------------

		RrmPolicy_-Attr:
		@@ -685,7 +701,8 @@ components:
		$ref: '#/components/schemas/RimRSGlobal-Single'
		Dynamic5QISet:
		$ref: '5gcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple'

		CCOFunction:
		$ref: '#/components/schemas/CCOFunction-Single'
		ManagedElement-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		@@ -1017,6 +1034,8 @@ components:
		properties:
		cellLocalId:
		type: integer
		administrativeState:
		$ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
		plmnInfoList:
		$ref: '#/components/schemas/PlmnInfoList'
		nrTac:
		@@ -1415,8 +1434,10 @@ components:
		properties:
		dmroControl:
		type: boolean
		maximumDeviationHoTrigger:
		$ref: '#/components/schemas/MaximumDeviationHoTrigger'
		maximumDeviationHoTriggerLow:
		$ref: '#/components/schemas/MaximumDeviationHoTriggerLow'
		maximumDeviationHoTriggerHigh:
		$ref: '#/components/schemas/MaximumDeviationHoTriggerHigh'
		minimumTimeBetweenHoTriggerChange:
		$ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange'
		tstoreUEcntxt:
		@@ -1797,6 +1818,57 @@ components:
		$ref: '#/components/schemas/LocalAddress'
		remoteAddress:
		$ref: '#/components/schemas/RemoteAddress'
		CCOFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		type: object
		properties:
		cCOControl:
		type: boolean
		cCOWeakCoverageParameters:
		$ref: '#/components/schemas/CCOWeakCoverageParameters-Single'
		cCOPilotPollutionParameters:
		$ref: '#/components/schemas/CCOPilotPollutionParameters-Single'
		cCOOvershootCoverageParameters-Single:
		$ref: '#/components/schemas/CCOOvershootCoverageParameters-Single'
		CCOParameters-Attr:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		type: object
		properties:
		coverageShapeList:
		type: integer
		downlinkTransmitPowerRange:
		$ref: '#/components/schemas/ParameterRange'
		antennaTiltRange:
		$ref: '#/components/schemas/ParameterRange'
		antennaAzimuthRange:
		$ref: '#/components/schemas/ParameterRange'
		digitalTiltRange:
		$ref: '#/components/schemas/ParameterRange'
		digitalAzimuthRange:
		$ref: '#/components/schemas/ParameterRange'

		CCOWeakCoverageParameters-Single:
		allOf:
		- $ref: '#/components/schemas/CCOParameters-Attr'
		- type: object

		CCOPilotPollutionParameters-Single:
		allOf:
		- $ref: '#/components/schemas/CCOParameters-Attr'
		- type: object

		CCOOvershootCoverageParameters-Single:
		allOf:
		- $ref: '#/components/schemas/CCOParameters-Attr'
		- type: object

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

		@@ -2016,3 +2088,7 @@ components:
		- $ref: '#/components/schemas/EP_NgU-Single'
		- $ref: '#/components/schemas/EP_X2U-Single'
		- $ref: '#/components/schemas/EP_S1U-Single'
		- $ref: '#/components/schemas/CCOFunction-Single'
		- $ref: '#/components/schemas/CCOWeakCoverageParameters-Single'
		- $ref: '#/components/schemas/CCOPilotPollutionParameters-Single'
		- $ref: '#/components/schemas/CCOOvershootCoverageParameters-Single'