add openAPI files from Integration-rel16-SA5-136 (15250f9d) · Commits · Miguel Angel Reina Ortega / Management and Orchestration APIs

OpenAPI/5gcNrm.yaml

0 → 100644

+1980 −0

File added.

Preview size limit exceeded, changes collapsed.

OpenAPI/FileDataReportingMnS.yaml

0 → 100644

+283 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: TS 28.532 File data reporting Service
		version: 16.6.0
		description: >-
		OAS 3.0.1 specification of the File data reporting Management Service © 2020,
		3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All
		rights reserved.
		externalDocs:
		description: 3GPP TS 28.532 V16.5.0; Generic management services
		url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/'
		servers:
		- url: '{MnSRoot}/FileDataReportingMnS/{MnSversion}'
		variables:
		MnSRoot:
		description: See subclause 4.4 of TS 32.158
		default: http://example.com/3GPPManagement
		version:
		description: Indicates the current version of the specification
		default: 16.5.0
		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 (fileaType, beginTime and endTime) of the URI. The fields query component allows to select the resource properties to be returned.
		parameters:
		- name: fileType
		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.
		required: true
		schema:
		$ref: '#/components/schemas/fileType-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.
		required: true
		schema:
		$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.
		required: true
		schema:
		$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.'
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/fileInfoRetrieval-ResponseType'
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/error-ResponseType'
		/subscriptions:
		post:
		summary: Create a subscription
		description: To create a subscription the representation of the subscription is POSTed on the /subscriptions collection resource.
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/subscription-RequestType'
		responses:
		'201':
		description: Success case ("201 Created"). The representation of the newly created subscription resource shall be returned.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/subscription-ResponseType'
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/error-ResponseType'
		callbacks:
		notifyFileReady:
		'{request.body#/consumerReference}':
		post:
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/notifyFileReady-NotifType'
		responses:
		'204':
		description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent.
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/error-ResponseType'
		notifyFilePreparationError:
		'{request.body#/consumerReference}':
		post:
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/notifyFilePreparationError-NotifType'
		responses:
		'204':
		description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent.
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$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.
		parameters:
		- name: consumerReferenceId
		in: query
		description: Identifies the subscriptions to be deleted.
		required: true
		schema:
		$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.
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/error-ResponseType'
		'/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.
		parameters:
		- name: subscriptionId
		in: path
		description: Identifies the subscription to be deleted.
		required: true
		schema:
		$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.
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/error-ResponseType'
		components:
		schemas:
		dateTime-Type:
		type: string
		format: date-Time
		uri-Type:
		type: string
		long-Type:
		type: string
		format: long
		additionalText-Type:
		type: string
		reason-Type:
		type: string
		fileInfoRetrieval-ResponseType:
		type: object
		properties:
		data:
		type: array
		items:
		$ref: '#/components/schemas/fileInfo-Type'
		fileInfo-Type:
		type: object
		properties:
		fileLocation:
		$ref: '#/components/schemas/uri-Type'
		fileSize:
		$ref: '#/components/schemas/long-Type'
		fileReadyTime:
		$ref: '#/components/schemas/dateTime-Type'
		fileExpirationTime:
		$ref: '#/components/schemas/dateTime-Type'
		fileCompression:
		type: string
		fileFormat:
		type: string
		fileType:
		$ref: '#/components/schemas/fileType-Type'
		error-ResponseType:
		type: object
		properties:
		error:
		type: object
		properties:
		errorInfo:
		type: string
		fileType-Type:
		type: string
		enum:
		- PERFORMANCE
		- TRACE
		- ANALYTICS
		- PROPRIETARY
		header-Type:
		description: Header used in notifications as notification header
		type: object
		properties:
		uri:
		$ref: '#/components/schemas/uri-Type'
		notificationId:
		$ref: '#/components/schemas/notificationId-Type'
		notificationType:
		$ref: '#/components/schemas/notificationType-Type'
		eventTime:
		$ref: '#/components/schemas/dateTime-Type'
		subscriptionId-PathType:
		type: string
		filter-Type:
		type: string
		notificationId-Type:
		$ref: '#/components/schemas/long-Type'
		notificationType-Type:
		type: string
		enum:
		- notifyFileReady
		- notifyFilePreparationError
		subscription-ResourceType:
		type: object
		properties:
		consumerReference:
		$ref: '#/components/schemas/uri-Type'
		timeTick:
		$ref: '#/components/schemas/long-Type'
		filter:
		$ref: '#/components/schemas/filter-Type'
		subscription-RequestType:
		type: object
		properties:
		data:
		$ref: '#/components/schemas/subscription-ResourceType'
		subscription-ResponseType:
		type: object
		properties:
		data:
		$ref: '#/components/schemas/subscription-ResourceType'
		consumerReferenceId-QueryType:
		$ref: '#/components/schemas/uri-Type'
		notifyFileReady-NotifType:
		type: object
		properties:
		header:
		$ref: '#/components/schemas/header-Type'
		body:
		type: object
		properties:
		fileInfoList:
		type: array
		items:
		$ref: '#/components/schemas/fileInfo-Type'
		additionalText:
		$ref: '#/components/schemas/additionalText-Type'
		notifyFilePreparationError-NotifType:
		type: object
		properties:
		header:
		$ref: '#/components/schemas/header-Type'
		body:
		type: object
		properties:
		fileInfoList:
		type: array
		items:
		$ref: '#/components/schemas/fileInfo-Type'
		reason:
		$ref: '#/components/schemas/reason-Type'
		additionalText:
		$ref: '#/components/schemas/additionalText-Type'

OpenAPI/README.md

0 → 100644

+69 −0

Original line number	Diff line number	Diff line
		# 3GPP SA5 models and MnS OpenAPI definitions

		(c) 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.

		The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML file of each API:

		<!-- APIs -->
		## Network Resource Models (NRM)

		* Generic NRM (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/genericNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/genericNrm.yaml))

		* Common NRM definitions (TS 28.623)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/comDefs.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/comDefs.yaml))

		* NR NRM (TS 28.541)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/nrNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/nrNrm.yaml))

		* 5GC NRM (TS 28.541)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/5gcNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/5gcNrm.yaml))

		* Slice NRM (TS 28.541)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/sliceNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/sliceNrm.yaml))

		* Communication Service Assurance NRM (TS 28.536)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/coslaNrm.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/coslaNrm.yaml))

		## Management Services (MnS)

		* Provisioning MnS (TS 28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/provMnS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/provMnS.yaml))

		* Fault Supervision MnS (TS 28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/faultMnS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/faultMnS.yaml))

		* Performance Monitoring MnS (28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerfMnS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerfMnS.yaml))

		* Heartbeat Notifications(TS 28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/heartbeatNtf.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/heartbeatNtf.yaml))

		* Streaming Data Reporting MnS (TS 28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/streamingDataMnS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/streamingDataMnS.yaml))

		* File Data Reporting MnS (TS 28.532)
		([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/FileDataReportMnS.yaml))
		([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/FileDataReportMnS.yaml))

		## Tools

		* [Frontend](https://forge.3gpp.org/swagger/tools/GitlabOpenAPIFrontend.htm) to invoke the Swagger Editor, Swagger UI, or to parse OpenAPI files with APIDevTools Swagger Parser/Validator, or to search for APIs referencing a data structure
		* [API Parser/Linter](https://forge.3gpp.org/swagger/tools/parser.html) to parse OpenAPI files with APIDevTools Swagger Parser/Validator and run a number of [lint](https://en.wikipedia.org/wiki/Lint_$software$) rules to improve API quality
		* [Data Type Finder](https://forge.3gpp.org/swagger/tools/types.html) to find the impacted APIs due to a change on a given data type
		* [API Versions Overview](https://forge.3gpp.org/swagger/tools/versions.html) to show a comprehensive report of the versions of all APIs in the repository

		## Other 3GPP API definitions

		* [CT4](https://forge.3gpp.org/rep/3GPP/5G_APIs) specifications.

OpenAPI/comDefs.yaml

0 → 100644

+152 −0

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

		Float:
		type: number
		format: float
		DateTime:
		type: string
		format: date-Time

		Dn:
		type: string
		DnList:
		type: array
		items:
		$ref: '#/components/schemas/Dn'

		Mcc:
		type: string
		pattern: '^[0-9]{3}$'
		Mnc:
		type: string
		pattern: '^[0-9]{2,3}$'
		PlmnId:
		type: object
		properties:
		mcc:
		$ref: '#/components/schemas/Mcc'
		mnc:
		$ref: '#/components/schemas/Mnc'
		required:
		- mcc
		- mnc

		Fqdn:
		type: string
		Uri:
		type: string

		Ipv4Addr:
		type: string
		pattern: '^(([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])\.){3}([0-9]\|[1-9][0-9]\|1[0-9][0-9]\|2[0-4][0-9]\|25[0-5])$'
		example: '198.51.100.1'
		Ipv6Addr:
		type: string
		allOf:
		- pattern: '^((:\|(0?\|([1-9a-f][0-9a-f]{0,3}))):)((0?\|([1-9a-f][0-9a-f]{0,3})):){0,6}(:\|(0?\|([1-9a-f][0-9a-f]{0,3})))$'
		- pattern: '^((([^:]+:){7}([^:]+))\|((([^:]+:)[^:]+)?::(([^:]+:)[^:]+)?))$'
		example: '2001:db8:85a3::8a2e:370:7334'
		Ipv6Prefix:
		type: string
		allOf:
		- pattern: '^((:\|(0?\|([1-9a-f][0-9a-f]{0,3}))):)((0?\|([1-9a-f][0-9a-f]{0,3})):){0,6}(:\|(0?\|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])\|([0-9]{2})\|(1[0-1][0-9])\|(12[0-8])))$'
		- pattern: '^((([^:]+:){7}([^:]+))\|((([^:]+:)[^:]+)?::(([^:]+:)[^:]+)?))(\/.+)$'
		example: '2001:db8:abcd:12::0/64'

		AdministrativeState:
		type: string
		enum:
		- LOCKED
		- UNLOCKED
		OperationalState:
		type: string
		enum:
		- ENABLED
		- DISABLED
		UsageState:
		type: string
		enum:
		- IDEL
		- ACTIVE
		- BUSY

		AttributeNameValuePairSet:
		description: >-
		The key of this map is the attribute name, and the value the attribute value.
		type: object
		minProperties: 1
		additionalProperties:
		nullable: true
		AttributeValueChangeSet:
		description: >-
		The first array item contains the attribute name value pairs with the new values,
		and the second array item the attribute name value pairs with the optional old values.
		type: array
		items:
		$ref: '#/components/schemas/AttributeNameValuePairSet'
		minItems: 1
		maxItems: 2

		Filter:
		type: string
		SystemDN:
		type: string

		NotificationId:
		type: integer
		NotificationType:
		oneOf:
		- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes'
		- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes'
		- $ref: 'perfMnS.yaml#/components/schemas/PerfNotificationTypes'
		- $ref: 'heartbeatNtf.yaml#/components/schemas/HeartbeatNotificationTypes'
		# The enum below will be replaced by a reference once notification
		# types are defined in "FileDataReportingMnS.yaml"
		- type: string
		enum:
		- notifyFileReady
		- notifyFilePreparationError
		NotificationHeader:
		type: object
		properties:
		href:
		$ref: '#/components/schemas/Uri'
		notificationId:
		$ref: '#/components/schemas/NotificationId'
		notificationType:
		$ref: '#/components/schemas/NotificationType'
		eventTime:
		$ref: '#/components/schemas/DateTime'
		systemDN:
		$ref: '#/components/schemas/SystemDN'
		required:
		- href
		- notificationId
		- notificationType
		- eventTime
		- systemDN

		ErrorResponse:
		description: >-
		Default schema for the response message body in case the request
		is not successful.
		type: object
		properties:
		error:
		type: object
		properties:
		errorInfo:
		type: string

OpenAPI/coslaNrm.yaml

0 → 100644

+152 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.2

		info:
		title: coslaNrm
		version: 16.4.0
		description:
		OAS 3.0.1 specification of the Cosla NRM
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 28.536 V16.4.0; Cosla NRM
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/

		paths: {}

		components:

		schemas:

		#------------ Type definitions ---------------------------------------------------

		ControlLoopLifeCyclePhase:
		type: string
		enum:
		- PREPARATION
		- COMMISSIONING
		- OPERATION
		- DECOMMISSIONING

		ObservationTime:
		type: integer

		AssuranceGoalStatusObserved:
		type: string
		enum:
		- FULFILLED
		- NOT_FULFILLED

		AssuranceGoalStatusPredicted:
		type: string
		enum:
		- FULFILLED
		- NOT_FULFILLED

		AssuranceTarget:
		type: object
		properties:
		assuranceTargetName:
		type: string
		assuranceTargetValue:
		type: string

		AssuranceTargetList:
		type: array
		items:
		$ref: '#/components/schemas/AssuranceTarget'


		#-------- 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'
		- $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO'
		- type: object
		properties:
		AssuranceClosedControlLoop:
		$ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple'

		ManagedElement-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr'
		- $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO'
		- type: object
		properties:
		AssuranceClosedControlLoop:
		$ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple'

		AssuranceClosedControlLoop-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		type: object
		properties:
		operationalState:
		$ref: 'comDefs.yaml#/components/schemas/OperationalState'
		administrativeState:
		$ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
		controlLoopLifeCyclePhase:
		$ref: '#/components/schemas/ControlLoopLifeCyclePhase'
		AssuranceGoal:
		$ref: '#/components/schemas/AssuranceGoal-Multiple'

		AssuranceGoal-Single:
		allOf:
		- $ref: 'genericNrm.yaml#/components/schemas/Top'
		- type: object
		properties:
		attributes:
		allOf:
		- type: object
		properties:
		observationTime:
		$ref: '#/components/schemas/ObservationTime'
		assuranceTargetList:
		$ref: '#/components/schemas/AssuranceTargetList'
		assuranceGoalStatusObserved:
		$ref: '#/components/schemas/AssuranceGoalStatusObserved'
		assuranceGoalStatusPredicted:
		$ref: '#/components/schemas/AssuranceGoalStatusPredicted'
		serviceProfileId:
		type: string
		sliceProfileId:
		type: string
		networkSliceRef:
		$ref: 'comDefs.yaml#/components/schemas/Dn'
		networkSliceSubnetRef:
		$ref: 'comDefs.yaml#/components/schemas/Dn'

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

		AssuranceClosedControlLoop-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/AssuranceClosedControlLoop-Single'

		AssuranceGoal-Multiple:
		type: array
		items:
		$ref: '#/components/schemas/AssuranceGoal-Single'

		#------------ Definitions in TS 28.536 for TS 28.623 -----------------------------

		resources-coslaNrm:
		oneOf:
		- $ref: '#/components/schemas/AssuranceClosedControlLoop-Single'
		- $ref: '#/components/schemas/AssuranceGoal-Single'
		- $ref: '#/components/schemas/SubNetwork-Single'
		- $ref: '#/components/schemas/ManagedElement-Single'