SA#96 (2f4c7037) · Commits · All Groups / 5G APIs

TS26512_M5_ServiceAccessInformation.yaml

+3 −3

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: M5_ServiceAccessInformation
		version: 1.0.0
		version: 1.0.1
		description: \|
		5GMS AF M5 Service Access Information API
		© 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.
		tags:
		- name: M5_ServiceAccessInformation
		description: '5G Media Streaming: Media Session Handling (M5) APIs: Service Access Information'
		externalDocs:
		description: 'TS 26.512 V16.2.0; 5G Media Streaming (5GMS); Protocols'
		description: 'TS 26.512 V16.6.0; 5G Media Streaming (5GMS); Protocols'
		url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
		servers:
		- url: '{apiRoot}/3gpp-m5/v1'

TS28532_FaultMnS.yaml

0 → 100644

+1058 −0

File added.

Preview size limit exceeded, changes collapsed.

TS28532_FileDataReportingMnS.yaml

0 → 100644

+229 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: File Data Reporting MnS
		version: 16.10.0
		description: >-
		OAS 3.0.1 definition of the File Data Reporting MnS
		© 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.532; Generic management services
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
		servers:
		- url: '{MnSRoot}/fileDataReportingMnS/{MnSVersion}'
		variables:
		MnSRoot:
		description: See clause 4.4.3 of TS 32.158
		default: http://example.com/3GPPManagement
		MnSVersion:
		description: Version number of the OpenAPI definition
		default: XXX
		paths:
		/files:
		get:
		summary: Read information about available files
		description: >-
		Information about available files is read with HTTP GET. The files for
		which information shall be returned are identified with the path
		component (base resource) and the query component (fileDataType, beginTime,
		endTime) of the URI.
		parameters:
		- name: fileDataType
		in: query
		description: >-
		This parameter selects files based on the file data type.
		required: true
		schema:
		$ref: '#/components/schemas/FileDataType'
		- name: beginTime
		in: query
		description: >-
		This parameter selects files based on the earliest time they
		became available
		required: false
		schema:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		- name: endTime
		in: query
		description: >-
		This parameter selects files based on the latest time they
		became available
		required: false
		schema:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		responses:
		'200':
		description: >-
		'Success case ("200 OK").
		The resources identified in the request for retrieval are returned
		in the response message body.'
		content:
		application/json:
		schema:
		type: array
		items:
		$ref: '#/components/schemas/FileInfo'
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse'
		/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: 'TS28532_FaultMnS.yaml#/components/schemas/Subscription'
		responses:
		'201':
		description: >-
		Success case ("201 Created").
		The representation of the newly created subscription resource shall
		be returned.
		content:
		application/json:
		schema:
		$ref: 'TS28532_FaultMnS.yaml#/components/schemas/Subscription'
		headers:
		Location:
		description: URI of the newly created subscription resource
		required: true
		schema:
		type: string
		default:
		description: Error case.
		content:
		application/json:
		schema:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse'
		callbacks:
		notifyFileReady:
		'{request.body#/consumerReference}':
		post:
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/NotifyFileReady'
		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: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse'
		notifyFilePreparationError:
		'{request.body#/consumerReference}':
		post:
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/NotifyFilePreparationError'
		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: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse'
		/subscriptions/{subscriptionId}:
		delete:
		summary: Delete a 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:
		type: string
		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: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse'
		components:
		schemas:
		FileDataType:
		type: string
		enum:
		- Performance
		- Trace
		- Analytics
		- Proprietary
		FileNotificationTypes:
		type: string
		enum:
		- notifyFileReady
		- notifyFilePreparationError
		FileInfo:
		type: object
		properties:
		fileLocation:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri'
		fileSize:
		type: integer
		fileReadyTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		fileExpirationTime:
		$ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime'
		fileCompression:
		type: string
		fileFormat:
		type: string
		fileDataType:
		$ref: '#/components/schemas/FileDataType'
		NotifyFileReady:
		allOf:
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader'
		- type: object
		properties:
		fileInfoList:
		type: array
		items:
		$ref: '#/components/schemas/FileInfo'
		additionalText:
		type: string
		NotifyFilePreparationError:
		allOf:
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader'
		- type: object
		properties:
		fileInfoList:
		type: array
		items:
		$ref: '#/components/schemas/FileInfo'
		reason:
		type: string
		additionalText:
		type: string

TS28532_HeartbeatNtf.yaml

0 → 100644

+25 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: Heartbeat notification
		version: 16.6.0
		description: >-
		OAS 3.0.1 definition of the heartbeat notification
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.532 V16.6.0; Generic management services
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.6532/
		paths: {}
		components:
		schemas:
		HeartbeatNotificationTypes:
		type: string
		enum:
		- notifyHeartbeat
		NotifyHeartbeat:
		allOf:
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader'
		- type: object
		properties:
		heartbeatNtfPeriod:
		type: integer

TS28532_PerfMnS.yaml

0 → 100644

+76 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.1
		info:
		title: TS 28.532 Performance Threshold Monitoring MnS
		version: 16.6.0
		description: >-
		OAS 3.0.1 definition of the Performance Threshold Monitoring MnS
		© 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		externalDocs:
		description: 3GPP TS 28.532 V16.6.0; Generic management services
		url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/
		servers:
		- url: '{root}'
		variables:
		root:
		description: >-
		The open API server of the performance threshold monitoring service is
		located in the consumer side, see monitoringNotifTarget attribute of
		the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11].
		default: http://example.com/3GPPManagement
		paths:
		/notificationSink:
		post:
		summary: Send notifications about performance threshold crossing
		description: To send a notifyThresholdCrossing notification
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/NotifyThresholdCrossing'
		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: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse'
		components:
		schemas:
		PerfNotificationTypes:
		type: string
		enum:
		- notifyThresholdCrossing
		PerfMetricValue:
		oneOf:
		- type: integer
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float'
		PerfMetricDirection:
		type: string
		enum:
		- UP
		- DOWN
		NotifyThresholdCrossing:
		allOf:
		- $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader'
		- type: object
		properties:
		observedPerfMetricName:
		type: string
		observedPerfMetricValue:
		$ref: '#/components/schemas/PerfMetricValue'
		observedPerfMetricDirection:
		$ref: '#/components/schemas/PerfMetricDirection'
		thresholdValue:
		$ref: '#/components/schemas/PerfMetricValue'
		hysteresis:
		$ref: '#/components/schemas/PerfMetricValue'
		monitorGranularityPeriod:
		type: integer
		additionalText:
		type: string