SA5#146 OpenAPI SS changes for Rel-18 (c39db6a2) · Commits · Miguel Angel Reina Ortega / Management and Orchestration APIs

OpenAPI/TS28541_5GcNrm.yaml

+433 −22

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: 3GPP 5GC NRM
		version: 17.7.0
		version: 18.2.0
		description: >-
		OAS 3.0.1 specification of the 5GC NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.541; 5G NRM, 5GC NRM
		@@ -134,6 +134,22 @@ components:
		properties:
		nFSrvGroupId:
		type: string
		supiRanges:
		type: array
		items:
		$ref: '#/components/schemas/SupiRange'
		minItems: 1
		routingIndicators:
		type: array
		items:
		type: string
		pattern: '^[0-9]{1,4}$'
		minItems: 1
		suciInfos:
		type: array
		items:
		$ref: '#/components/schemas/SuciInfo'
		minItems: 1
		SupportedDataSet:
		type: string
		description: any of enumrated value
		@@ -154,9 +170,6 @@ components:
		- P_BDT
		- P_PLMNUE
		- P_NSSCD
		NFInfo:
		oneOf:
		- $ref: '#/components/schemas/AusfInfo'
		NotificationType:
		type: string
		enum:
		@@ -218,8 +231,6 @@ components:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai'
		locality:
		type: string
		nFInfo:
		$ref: '#/components/schemas/NFInfo'
		capacity:
		type: integer
		nfSetIdList:
		@@ -764,6 +775,368 @@ components:
		fqdn:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn'

		Ipv4AddressRange:
		description: Range of IPv4 addresses
		type: object
		properties:
		start:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr'
		end:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr'
		Ipv6PrefixRange:
		description: Range of IPv6 prefixes
		type: object
		properties:
		start:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
		end:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
		Nid:
		type: string
		pattern: '^[A-Fa-f0-9]{11}$'
		PlmnIdNid:
		type: object
		properties:
		mcc:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc'
		mnc:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc'
		nid:
		$ref: '#/components/schemas/Nid'
		ScpCapability:
		type: string
		enum:
		- INDIRECT_COM_WITH_DELEG_DISC
		IpReachability:
		description: Indicates the type(s) of IP addresses reachable via an SCP
		anyOf:
		- type: string
		enum:
		- IPV4
		- IPV6
		- IPV4V6
		- type: string

		ScpDomainInfo:
		description: SCP Domain specific information
		type: object
		properties:
		scpFqdn:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn'
		scpIpEndPoints:
		type: array
		items:
		$ref: 'TS28541_5GcNrm.yaml#/components/schemas/IpEndPoint'
		minItems: 1
		scpPrefix:
		type: string
		scpPorts:
		description: >
		Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https".
		type: object
		additionalProperties:
		type: integer
		minimum: 0
		maximum: 65535
		minProperties: 1

		SeppInfo:
		description: Information of a SEPP Instance
		type: object
		properties:
		seppPrefix:
		type: string
		seppPorts:
		description: >
		Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https".
		type: object
		additionalProperties:
		type: integer
		minimum: 0
		maximum: 65535
		minProperties: 1
		remotePlmnList:
		type: array
		items:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/PlmnId'
		minItems: 1
		remoteSnpnList:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
		minItems: 1

		UdsfInfo:
		description: Information related to UDSF
		type: object
		properties:
		groupId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
		supiRanges:
		type: array
		items:
		$ref: '#/components/schemas/SupiRange'
		minItems: 1
		storageIdRanges:
		description: >
		A map (list of key-value pairs) where realmId serves as key and each value in the map
		is an array of IdentityRanges. Each IdentityRange is a range of storageIds.
		type: object
		additionalProperties:
		type: array
		items:
		$ref: '#/components/schemas/IdentityRange'
		minItems: 1
		minProperties: 1

		NsacfCapability:
		description: >
		NSACF service capabilities (e.g. to monitor and control the number of registered UEs
		or established PDU sessions per network slice)
		type: object
		properties:
		supportUeSAC:
		description: \|
		Indicates the service capability of the NSACF to monitor and control the number of
		registered UEs per network slice for the network slice that is subject to NSAC
		true: Supported
		false (default): Not Supported
		type: boolean
		default: false
		supportPduSAC:
		description: \|
		Indicates the service capability of the NSACF to monitor and control the number of
		established PDU sessions per network slice for the network slice that is subject to NSAC
		true: Supported
		false (default): Not Supported
		type: boolean
		default: false

		NsacfInfo:
		description: Information of a NSACF NF Instance
		type: object
		required:
		- nsacfCapability
		properties:
		nsacfCapability:
		$ref: '#/components/schemas/NsacfCapability'
		taiList:
		$ref: '#/components/schemas/TaiList'
		taiRangeList:
		type: array
		items:
		$ref: '#/components/schemas/TaiRange'
		minItems: 1

		NwdafCapability:
		description: Indicates the capability supported by the NWDAF
		type: object
		properties:
		analyticsAggregation:
		type: boolean
		default: false
		analyticsMetadataProvisioning:
		type: boolean
		default: false
		MlAnalyticsInfo:
		description: ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service
		type: object
		properties:
		mlAnalyticsIds:
		type: array
		items:
		$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
		minItems: 1
		snssaiList:
		$ref: '#/components/schemas/SnssaiList'
		trackingAreaList:
		$ref: '#/components/schemas/TaiList'

		NwdafInfo:
		description: Information of a NWDAF NF Instance
		type: object
		properties:
		eventIds:
		type: array
		items:
		$ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId'
		minItems: 1
		nwdafEvents:
		type: array
		items:
		$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
		minItems: 1

		ScpInfo:
		description: Information of an SCP Instance
		type: object
		properties:
		scpDomainInfoList:
		description: >
		A map (list of key-value pairs) where the key of the map shall be the string
		identifying an SCP domain
		type: object
		additionalProperties:
		$ref: '#/components/schemas/ScpDomainInfo'
		minProperties: 1
		scpPrefix:
		type: string
		scpPorts:
		description: >
		Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https".
		type: object
		additionalProperties:
		type: integer
		minimum: 0
		maximum: 65535
		minProperties: 1
		addressDomains:
		type: array
		items:
		type: string
		minItems: 1
		ipv4Addresses:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
		minItems: 1
		ipv6Prefixes:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
		minItems: 1
		ipv4AddrRanges:
		type: array
		items:
		$ref: '#/components/schemas/Ipv4AddressRange'
		minItems: 1
		ipv6PrefixRanges:
		type: array
		items:
		$ref: '#/components/schemas/Ipv6PrefixRange'
		minItems: 1
		servedNfSetIdList:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
		minItems: 1
		remotePlmnList:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
		minItems: 1
		remoteSnpnList:
		type: array
		items:
		$ref: '#/components/schemas/PlmnIdNid'
		minItems: 1
		ipReachability:
		$ref: '#/components/schemas/IpReachability'
		scpCapabilities:
		type: array
		items:
		$ref: '#/components/schemas/ScpCapability'

		PfdData:
		description: List of Application IDs and/or AF IDs managed by a given NEF Instance
		type: object
		properties:
		appIds:
		type: array
		items:
		type: string
		minItems: 1
		afIds:
		type: array
		items:
		type: string
		minItems: 1
		AfEvent:
		description: Represents Application Events.
		anyOf:
		- type: string
		enum:
		- SVC_EXPERIENCE
		- UE_MOBILITY
		- UE_COMM
		- EXCEPTIONS
		- USER_DATA_CONGESTION
		- PERF_DATA
		- DISPERSION
		- COLLECTIVE_BEHAVIOUR
		- MS_QOE_METRICS
		- MS_CONSUMPTION
		- MS_NET_ASSIST_INVOCATION
		- MS_DYN_POLICY_INVOCATION
		- MS_ACCESS_ACTIVITY
		- 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.
		AfEventExposureData:
		description: AF Event Exposure data managed by a given NEF Instance
		type: object
		required:
		- afEvents
		properties:
		afEvents:
		type: array
		items:
		$ref: '#/components/schemas/AfEvent'
		minItems: 1
		afIds:
		type: array
		items:
		type: string
		minItems: 1
		appIds:
		type: array
		items:
		type: string
		minItems: 1
		UnTrustAfInfo:
		description: Information of a untrusted AF Instance
		type: object
		required:
		- afId
		properties:
		afId:
		type: string
		sNssaiInfoList:
		type: array
		items:
		$ref: '#/components/schemas/SnssaiInfoItem'
		minItems: 1
		mappingInd:
		type: boolean
		default: false
		SnssaiInfoItem:
		description: >
		Parameters supported by an NF for a given S-NSSAI Set of parameters supported by NF
		for a given S-NSSAI
		type: object
		required:
		- sNssai
		- dnnInfoList
		properties:
		sNssai:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai'
		dnnInfoList:
		type: array
		items:
		$ref: '#/components/schemas/DnnInfoItem'
		minItems: 1
		DnnInfoItem:
		description: Set of parameters supported by NF for a given DNN
		type: object
		required:
		- dnn
		properties:
		dnn:
		anyOf:
		- $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
		- $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn'

		#-------- Definition of concrete IOCs --------------------------------------------
		ProvMnS:
		oneOf:
		@@ -1224,16 +1597,16 @@ components:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		plmnIdList:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList'
		plmnInfoList:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList'
		sBIFqdn:
		type: string
		snssaiList:
		$ref: '#/components/schemas/SnssaiList'
		managedNFProfile:
		$ref: '#/components/schemas/ManagedNFProfile'
		commModelList:
		$ref: '#/components/schemas/CommModelList'
		ausfInfo:
		$ref: '#/components/schemas/AusfInfo'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:
		@@ -1325,14 +1698,15 @@ components:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr'
		- type: object
		properties:
		plmnIdList:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList'
		plmnInfoList:
		$ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList'
		sBIFqdn:
		type: string
		snssaiList:
		$ref: '#/components/schemas/SnssaiList'
		managedNFProfile:
		$ref: '#/components/schemas/ManagedNFProfile'
		udsfInfo:
		$ref: '#/components/schemas/UdsfInfo'

		NrfFunction-Single:
		allOf:
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top'
		@@ -1476,6 +1850,8 @@ components:
		type: integer
		fqdn:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn'
		seppInfo:
		$ref: '#/components/schemas/SeppInfo'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:
		@@ -1503,10 +1879,10 @@ components:
		$ref: '#/components/schemas/CommModelList'
		networkSliceInfoList:
		$ref: '#/components/schemas/NetworkSliceInfoList'
		nwdafEvents:
		type: array
		items:
		$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
		administrativeState:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState'
		nwdafInfo:
		$ref: '#/components/schemas/NwdafInfo'

		ScpFunction-Single:
		allOf:
		@@ -1522,6 +1898,8 @@ components:
		$ref: '#/components/schemas/SupportedFuncList'
		address:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr'
		scpInfo:
		$ref: '#/components/schemas/ScpInfo'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		NefFunction-Single:
		allOf:
		@@ -1551,7 +1929,40 @@ components:
		$ref: '#/components/schemas/TaiRange'
		dnai:
		type: string

		nefId:
		type: string
		pfdData:
		$ref: '#/components/schemas/PfdData'
		afEeData:
		$ref: '#/components/schemas/AfEventExposureData'
		gpsiRanges:
		type: array
		items:
		$ref: '#/components/schemas/IdentityRange'
		minItems: 1
		externalGroupIdentifiersRanges:
		type: array
		items:
		$ref: '#/components/schemas/IdentityRange'
		minItems: 1
		servedFqdnList:
		type: array
		items:
		type: string
		minItems: 1
		dnaiList:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
		minItems: 1
		unTrustAfInfoList:
		type: array
		items:
		$ref: '#/components/schemas/UnTrustAfInfo'
		minItems: 1
		uasNfFunctionalityInd:
		type: boolean
		default: false
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:
		@@ -1573,8 +1984,8 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/NsacfInfoSnssai'
		taiList:
		$ref: '#/components/schemas/TaiList'
		nsacfInfo:
		$ref: '#/components/schemas/NsacfInfo'
		- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:

OpenAPI/TS28541_NrNrm.yaml

+9 −7

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: NR NRM
		version: 17.7.0
		version: 18.2.0
		description: >-
		OAS 3.0.1 specification of the NR NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.541; 5G NRM, NR NRM
		@@ -825,16 +825,18 @@ components:
		$ref: '#/components/schemas/GnbName'
		plmnId:
		$ref: '#/components/schemas/PlmnId'
		x2BlackList:
		x2BlockList:
		$ref: '#/components/schemas/GGnbIdList'
		xnBlackList:
		xnBlockList:
		$ref: '#/components/schemas/GGnbIdList'
		x2WhiteList:
		x2AllowList:
		$ref: '#/components/schemas/GGnbIdList'
		xnWhiteList:
		xnAllowList:
		$ref: '#/components/schemas/GGnbIdList'
		x2XnHOBlackList:
		x2HOBlockList:
		$ref: '#/components/schemas/GEnbIdList'
		xnHOBlackList:
		$ref: '#/components/schemas/GGnbIdList'
		mappingSetIDBackhaulAddress:
		$ref: '#/components/schemas/MappingSetIDBackhaulAddress'
		tceMappingInfoList:

OpenAPI/TS28541_SliceNrm.yaml

+9 −5

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Slice NRM
		version: 17.7.0
		version: 18.2.0
		description: >-
		OAS 3.0.1 specification of the Slice NRM
		@ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@ 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.541; 5G NRM, Slice NRM
		@@ -115,7 +115,9 @@ components:
		availability:
		$ref: '#/components/schemas/Support'
		periodicityList:
		type: string
		type: array
		items:
		type: integer
		XLThpt:
		type: object
		properties:
		@@ -145,6 +147,8 @@ components:
		servAttrCom:
		$ref: '#/components/schemas/ServAttrCom'
		kPIList:
		type: array
		items:
		type: string
		NBIoT:
		type: object
		@@ -511,7 +515,7 @@ components:
		$ref: '#/components/schemas/Positioning'
		userMgmtOpen:
		$ref: '#/components/schemas/UserMgmtOpen'
		v2XModels:
		v2XCommModels:
		$ref: '#/components/schemas/V2XCommModels'
		coverageArea:
		type: string

OpenAPI/TS28623_ComDefs.yaml

+9 −3

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Common Type Definitions
		version: 17.1.0
		version: 18.1.0
		description: >-
		OAS 3.0.1 specification of common type definitions in the Generic NRM
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.623; Generic NRM; Common type definitions
		@@ -82,11 +82,17 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/GeoCoordinate'
		GeoAreaToCellMapping:
		minItems: 3
		GeoArea:
		type: object
		properties:
		convexGeoPolygon:
		$ref: '#/components/schemas/ConvexGeoPolygon'
		GeoAreaToCellMapping:
		type: object
		properties:
		geoArea:
		$ref: '#/components/schemas/GeoArea'
		associationThreshold:
		type: integer
		AreaOfInterest:

OpenAPI/TS28623_GenericNrm.yaml

+76 −3

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Generic NRM
		version: 17.1.0
		version: 18.1.0
		description: >-
		OAS 3.0.1 definition of the Generic NRM
		© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -82,7 +82,7 @@ components:
		$ref: '#/components/schemas/OperationSemantics'
		NFType:
		type: string
		description: ' NF name defined in TS 23.501'
		description: ' NF name defined in TS 23.501 or TS 29.510'
		enum:
		- NRF
		- UDM
		@@ -103,6 +103,49 @@ components:
		- AF
		- UDSF
		- DN
		- BSF
		- CHF
		- NWDAF
		- PCSCF
		- CBCF
		- HSS
		- UCMF
		- SOR_AF
		- SPAF
		- MME
		- SCSAS
		- SCEF
		- SCP
		- NSSAAF
		- ICSCF
		- SCSCF
		- DRA
		- IMS_AS
		- AANF
		- 5G_DDNMF
		- NSACF
		- MFAF
		- EASDF
		- DCCF
		- MB_SMF
		- TSCTSF
		- ADRF
		- GBA_BSF
		- CEF
		- MB_UPF
		- NSWOF
		- PKMF
		- MNPF
		- SMS_GMSC
		- SMS_IWMSC
		- MBSF
		- MBSTF
		- PANF
		- TNGF
		- W_AGF
		- TWIF
		- TSN_AF

		OperationSemantics:
		type: string
		enum:
		@@ -1414,6 +1457,34 @@ components:
		description: See details in 3GPP TS 32.422 clause 5.10.11. Only TCE Id value may be sent over the air to the UE being configured for Logged MDT.
		type: integer

		excessPacketDelayThresholds-Type:
		description: Excess Packet Delay Threshold for NR MDT. See details in 3GPP TS 32.422 clause 4.1.1 and 4.1.2.
		type: array
		properties:
		fiveQIValue:
		type: integer
		excessPacketDelayThresholdValue:
		type: string
		enum:
		- 0.25ms
		- 0.5ms
		- 1ms
		- 2ms
		- 4ms
		- 5ms
		- 10ms
		- 20ms
		- 30ms
		- 40ms
		- 50ms
		- 60ms
		- 70ms
		- 80ms
		- 90ms
		- 100ms
		- 150ms
		- 300ms
		- 500ms

		#-------- end of Definition of types used in Trace control NRM fragment ----------

		@@ -1690,6 +1761,8 @@ components:
		$ref: '#/components/schemas/sensorInformation-Type'
		traceCollectionEntityId:
		$ref: '#/components/schemas/traceCollectionEntityId-Type'
		excessPacketDelayThresholds:
		$ref: '#/components/schemas/excessPacketDelayThresholds-Type'

		ManagedFunction-ncO:
		type: object
		@@ -1909,7 +1982,7 @@ components:
		collectionTimeWindow:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow'
		reportingCtrl:
		type: string
		$ref: '#/components/schemas/ReportingCtrl'
		dataScope:
		type: string
		enum: