Extracted OpenAPI definitions from the TSs published in July 2020 (a047794b) · Commits · Miguel Angel Reina Ortega / Management and Orchestration APIs

OpenAPI/5gcNrm.yaml

+255 −65

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: 3GPP 5GC NRM
		version: 16.4.0
		version: 16.5.0
		description: >-
		OAS 3.0.1 specification of the 5GC NRM
		@ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		© 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
		@@ -116,13 +116,13 @@ components:
		enum:
		- REGISTERED
		- SUSPENDED
		NSIIdList:
		CNSIIdList:
		type: array
		items:
		$ref: '#/components/schemas/NSIId'
		NSIId:
		$ref: '#/components/schemas/CNSIId'
		CNSIId:
		type: string
		description: NSI Id is defined in TS 29.531
		description: CNSI Id is defined in TS 29.531, only for Core Network
		TACList:
		type: array
		items:
		@@ -234,6 +234,70 @@ components:
		type: array
		items:
		type: string
		FiveQiDscpMapping:
		type: object
		properties:
		fiveQIValues:
		type: array
		items:
		type: integer
		dscp:
		type: integer

		PacketErrorRate:
		type: object
		properties:
		scalar:
		type: integer
		exponent:
		type: integer
		FiveQICharacteristics:
		type: object
		properties:
		fiveQIValue:
		type: integer
		resourceType:
		type: string
		enum:
		- GBR
		- NonGBR
		priorityLevel:
		type: integer
		packetDelayBudget:
		type: integer
		packetErrorRate:
		$ref: '#/components/schemas/PacketErrorRate'
		averagingWindow:
		type: integer
		maximumDataBurstVolume:
		type: integer


		GtpUPathDelayThresholdsType:
		type: object
		properties:
		n3AveragePacketDelayThreshold:
		type: integer
		n3MinPacketDelayThreshold:
		type: integer
		n3MaxPacketDelayThreshold:
		type: integer
		n9AveragePacketDelayThreshold:
		type: integer
		n9MinPacketDelayThreshold:
		type: integer
		n9MaxPacketDelayThreshold:
		type: integer
		QFPacketDelayThresholdsType:
		type: object
		properties:
		thresholdDl:
		type: integer
		thresholdUl:
		type: integer
		thresholdRtt:
		type: integer


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

		@@ -262,6 +326,9 @@ components:
		$ref: '#/components/schemas/AmfSet-Multiple'
		AmfRegion:
		$ref: '#/components/schemas/AmfRegion-Multiple'
		Configurable5QISet:
		$ref: '#/components/schemas/Configurable5QISet-Multiple'

		ManagedElement-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		@@ -309,6 +376,8 @@ components:
		$ref: '#/components/schemas/ScpFunction-Multiple'
		NefFunction:
		$ref: '#/components/schemas/NefFunction-Multiple'
		Configurable5QISet:
		$ref: '#/components/schemas/Configurable5QISet-Multiple'

		AmfFunction-Single:
		allOf:
		@@ -421,6 +490,9 @@ components:
		$ref: '#/components/schemas/ManagedNFProfile'
		commModelList:
		$ref: '#/components/schemas/CommModelList'
		Configurable5QISetRef:
		$ref: 'genericNRM.yaml#/components/schemas/Dn'

		- $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO'
		- type: object
		properties:
		@@ -436,6 +508,13 @@ components:
		$ref: '#/components/schemas/EP_N16-Multiple'
		EP_S5C:
		$ref: '#/components/schemas/EP_S5C-Multiple'
		FiveQiDscpMappingSet:
		$ref: '#/components/schemas/FiveQiDscpMappingSet-Single'
		GtpUPathQoSMonitoringControl:
		$ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single'
		QFQoSMonitoringControl:
		$ref: '#/components/schemas/QFQoSMonitoringControl-Single'

		UpfFunction-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
		@@ -629,8 +708,8 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
		sBIFqdn:
		type: string
		nSIIdList:
		$ref: '#/components/schemas/NSIIdList'
		cNSIIdList:
		$ref: '#/components/schemas/CNSIIdList'
		nFProfileList:
		$ref: '#/components/schemas/NFProfileList'
		snssaiList:
		@@ -654,8 +733,8 @@ components:
		$ref: 'nrNrm.yaml#/components/schemas/PlmnIdList'
		sBIFqdn:
		type: string
		nSIIdList:
		$ref: '#/components/schemas/NSIIdList'
		cNSIIdList:
		$ref: '#/components/schemas/CNSIIdList'
		nFProfileList:
		$ref: '#/components/schemas/NFProfileList'
		snssaiList:
		@@ -1301,6 +1380,108 @@ components:
		remoteAddress:
		$ref: 'nrNrm.yaml#/components/schemas/RemoteAddress'

		FiveQiDscpMappingSet-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		FiveQiDscpMappingList:
		type: array
		items:
		$ref: '#/components/schemas/FiveQiDscpMapping'

		Configurable5QISet-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		configurable5QIs:
		type: array
		items:
		$ref: '#/components/schemas/FiveQICharacteristics'
		GtpUPathQoSMonitoringControl-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		gtpUPathQoSMonitoringState:
		type: string
		enum:
		- ENABLED
		- DISABLED
		gtpUPathMonitoredSNSSAIs:
		type: array
		items:
		$ref: 'nrNrm.yaml#/components/schemas/Snssai'
		monitoredDSCPs:
		type: array
		items:
		type: integer
		minimum: 0
		maximum: 255
		isEventTriggeredGtpUPathMonitoringSupported:
		type: boolean
		isPeriodicGtpUMonitoringSupported:
		type: boolean
		isImmediateGtpUMonitoringSupported:
		type: boolean
		gtpUPathDelayThresholds:
		$ref: '#/components/schemas/GtpUPathDelayThresholdsType'
		gtpUPathMinimumWaitTime:
		type: integer
		gtpUPathMeasurementPeriod:
		type: integer

		QFQoSMonitoringControl-Single:
		allOf:
		- $ref: 'genericNRM.yaml#/components/schemas/Top-Attr'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		qFQoSMonitoringState:
		type: string
		enum:
		- ENABLED
		- DISABLED
		qFMonitoredSNSSAIs:
		type: array
		items:
		$ref: 'nrNrm.yaml#/components/schemas/Snssai'
		qFMonitored5QIs:
		type: array
		items:
		type: integer
		minimum: 0
		maximum: 255
		isEventTriggeredQFMonitoringSupported:
		type: boolean
		isPeriodicQFMonitoringSupported:
		type: boolean
		isSessionReleasedQFMonitoringSupported:
		type: boolean
		qFPacketDelayThresholds:
		$ref: '#/components/schemas/QFPacketDelayThresholdsType'
		qFMinimumWaitTime:
		type: integer
		qFMeasurementPeriod:
		type: integer


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

		SubNetwork-Multiple:
		@@ -1530,6 +1711,11 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/EP_NLG-Single'
		Configurable5QISet-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/Configurable5QISet-Single'


		#------------ Definitions in TS 28.541 for TS 28.532 -----------------------------

		@@ -1563,6 +1749,8 @@ components:

		- $ref: '#/components/schemas/AmfSet-Single'
		- $ref: '#/components/schemas/AmfRegion-Single'
		- $ref: '#/components/schemas/QFQoSMonitoringControl-Single'
		- $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single'

		- $ref: '#/components/schemas/EP_N2-Single'
		- $ref: '#/components/schemas/EP_N3-Single'
		@@ -1597,3 +1785,5 @@ components:
		- $ref: '#/components/schemas/EP_MAP_SMSC-Single'
		- $ref: '#/components/schemas/EP_NLS-Single'
		- $ref: '#/components/schemas/EP_NLG-Single'
		- $ref: '#/components/schemas/Configurable5QISet-Single'
		- $ref: '#/components/schemas/FiveQiDscpMappingSet-Single'

OpenAPI/PerDataFileReportMnS.yaml

+25 −60

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: TS 28.532 Performance data file reporting Service
		version: 16.1.0
		description: OAS 3.0.1 specification of the Performance Data File Reporting Service
		version: 16.4.0
		description: >-
		OAS 3.0.1 specification of the Performance data file reporting Management Service © 2020,
		3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All
		rights reserved.
		externalDocs:
		description: 3GPP TS 28.532 V16.4.0; Generic management services
		url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/'
		servers:
		- url: >-
		http://{DN_prefix_authority_part}/{DN_prefix_remainder}/PerfDataFileReportMnS/v1610
		- url: '{MnSRoot}/PerfDataFileReportMnS/v1640'
		variables:
		DN_prefix_authority_part:
		description: See subclause 4.4 of TS 32.158
		default: example.com
		DN_prefix_remainder:
		MnSRoot:
		description: See subclause 4.4 of TS 32.158
		default: ''
		default: http://example.com/3GPPManagement
		paths:
		/Files:
		get:
		summary: Read resources of information of available files
		description: >-
		With HTTP GET, resources of information of available files are read. The
		resources to be read are identified with the path component (base
		resource) and the query component (managementDataType, beginTime and
		endTime) of the URI. The fields query component allows to select the
		resource properties to be returned.
		description: 'With HTTP GET, resources of information of available files are read. The resources to be read are identified with the path component (base resource) and the query component (managementDataType, beginTime and endTime) of the URI. The fields query component allows to select the resource properties to be returned.'
		parameters:
		- name: managementDataType
		in: query
		description: >-
		This parameter identifies the type of management data that the file
		contains to select the resources from the collection resources
		identified with the path component of the URI.
		description: This parameter identifies the type of management data that the file contains to select the resources from the collection resources identified with the path component of the URI.
		required: true
		$ref: '#/components/schemas/managementDataType-Type'
		- name: beginTime
		in: query
		description: >-
		This parameter identifies the time stamp no later than which the
		file became available to select the resources from the collection
		resources identified with the path component of the URI.
		description: This parameter identifies the time stamp no later than which the file became available to select the resources from the collection resources identified with the path component of the URI.
		required: true
		$ref: '#/components/schemas/dateTime-Type'
		- name: endTime
		in: query
		description: >-
		This parameter identifies the time stamp no earlier than which the
		file became available to select the resources from the collection
		resources identified with the path component of the URI.
		description: This parameter identifies the time stamp no earlier than which the file became available to select the resources from the collection resources identified with the path component of the URI.
		required: true
		$ref: '#/components/schemas/dateTime-Type'
		responses:
		'200':
		description: >-
		Success case ("200 OK"). The resources identified in the request for
		retrieval are returned in the response message body. In case the
		fields query parameter is used, the selected resources are returned.
		description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.'
		content:
		application/json:
		schema:
		@@ -67,9 +52,7 @@ paths:
		/subscriptions:
		post:
		summary: Create a subscription
		description: >-
		To create a subscription the representation of the subscription is
		POSTed on the /subscriptions collection resource.
		description: To create a subscription the representation of the subscription is POSTed on the /subscriptions collection resource.
		requestBody:
		required: true
		content:
		@@ -78,9 +61,7 @@ paths:
		$ref: '#/components/schemas/subscription-RequestType'
		responses:
		'201':
		description: >-
		Success case ("201 Created"). The representation of the newly
		created subscription resource shall be returned.
		description: Success case ("201 Created"). The representation of the newly created subscription resource shall be returned.
		content:
		application/json:
		schema:
		@@ -103,9 +84,7 @@ paths:
		$ref: '#/components/schemas/notifyFileReady-NotifType'
		responses:
		'204':
		description: >-
		Success case ("204 No Content"). The notification is
		successfully delivered. The response message body is absent.
		description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent.
		default:
		description: Error case.
		content:
		@@ -120,13 +99,10 @@ paths:
		content:
		application/json:
		schema:
		$ref: >-
		#/components/schemas/notifyFilePreparationError-NotifType
		$ref: '#/components/schemas/notifyFilePreparationError-NotifType'
		responses:
		'204':
		description: >-
		Success case ("204 No Content"). The notification is
		successfully delivered. The response message body is absent.
		description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent.
		default:
		description: Error case.
		content:
		@@ -135,11 +111,7 @@ paths:
		$ref: '#/components/schemas/error-ResponseType'
		delete:
		summary: Delete all subscriptions made with a specific consumerReferenceId
		description: >-
		The subscriptions are deleted by deleting the corresponding subscription
		resources. The resources to be deleted are identified with the path
		component of the URI pointing to the /subscription collection resource
		and filtering on the consumerReferenceId provided in the query part.
		description: The subscriptions are deleted by deleting the corresponding subscription resources. The resources to be deleted are identified with the path component of the URI pointing to the /subscription collection resource and filtering on the consumerReferenceId provided in the query part.
		parameters:
		- name: consumerReferenceId
		in: query
		@@ -149,9 +121,7 @@ paths:
		$ref: '#/components/schemas/consumerReferenceId-QueryType'
		responses:
		'204':
		description: >-
		Success case ("204 No Content"). The subscription resources have
		been deleted. The response message body is absent.
		description: Success case ("204 No Content"). The subscription resources have been deleted. The response message body is absent.
		default:
		description: Error case.
		content:
		@@ -161,10 +131,7 @@ paths:
		'/subscriptions/{subscriptionId}':
		delete:
		summary: Delete a single subscription
		description: >-
		The subscription is deleted by deleting the corresponding subscription
		resource. The resource to be deleted is identified with the path
		component of the URI.
		description: The subscription is deleted by deleting the corresponding subscription resource. The resource to be deleted is identified with the path component of the URI.
		parameters:
		- name: subscriptionId
		in: path
		@@ -174,9 +141,7 @@ paths:
		$ref: '#/components/schemas/subscriptionId-PathType'
		responses:
		'204':
		description: >-
		Success case ("204 No Content"). The subscription resource has been
		deleted. The response message body is absent.
		description: Success case ("204 No Content"). The subscription resource has been deleted. The response message body is absent.
		default:
		description: Error case.
		content:

OpenAPI/PerMeasJobCtlMnS.yaml

0 → 100644

+280 −0

File added.

Preview size limit exceeded, changes collapsed.

OpenAPI/PerThresMonMnS.yaml

+1 −1

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: TS 28.532 Performance Threshold Monitoring Service
		version: 16.1.0
		version: 16.4.0
		description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service
		servers:
		- url: 'http://{monitoringNotifTarget}'

OpenAPI/PerfDataStreamingMnS.yaml

0 → 100644

+363 −0

File added.

Preview size limit exceeded, changes collapsed.