SA#102 (76ed6009) · Commits · All Groups / 5G APIs

TS26512_CommonData.yaml

+139 −2

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 5GMS Common Data Types
		version: 2.0.2
		version: 3.0.0
		description: \|
		5GMS Common Data Types
		© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -10,7 +10,7 @@ tags:
		- name: 5GMS Common Data Types
		description: '5G Media Streaming: Common Data Types'
		externalDocs:
		description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols'
		description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols'
		url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
		paths: {}
		components:
		@@ -26,6 +26,10 @@ components:
		minimum: 0.0
		maximum: 100.0
		#DurationSec is defined in TS29571_CommonData
		Duration:
		type: string
		format: duration
		description: 'String with format "duration" as defined by JSON Schema (referencing IETF RFC 3339, appendix A and, ultimately, ISO 8601).'
		#DateTime is defined in TS29571_CommonData
		#Uri is defined in TS29571_CommonData
		Url:
		@@ -40,6 +44,9 @@ components:
		type: string
		format: uri
		description: 'Absolute Uniform Resource Locator, conforming with the "absolute-URI" production specified in IETF RFC 3986, section 4.3 in which the scheme part is "http" or "https". Note that the "query" suffix is permitted by this production but the "fragment" suffix is not.'
		MediaDeliverySessionId:
		type: string
		description: 'A unique identifier for a media delivery session.'

		#####################################
		# Clause 6.4.3: Structured data types
		@@ -193,6 +200,136 @@ components:
		appRequest:
		type: boolean

		MediaStreamingSessionIdentification:
		type: object
		required:
		- sessionId
		properties:
		sessionId:
		$ref: '#/components/schemas/MediaDeliverySessionId'

		MediaStreamingAccess:
		type: object
		description: Common properties of a single media access by the Media Stream Handler.
		required:
		- mediaStreamHandlerEndpointAddress
		- applicationServerEndpointAddress
		- requestMessage
		- responseMessage
		- processingLatency
		properties:
		mediaStreamHandlerEndpointAddress:
		$ref: '#/components/schemas/EndpointAddress'
		applicationServerEndpointAddress:
		$ref: '#/components/schemas/EndpointAddress'
		requestMessage:
		type: object
		required:
		- method
		- url
		- protocolVersion
		- size
		- bodySize
		properties:
		method:
		type: string
		url:
		$ref: '#/components/schemas/AbsoluteUrl'
		protocolVersion:
		type: string
		range:
		type: string
		size:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		bodySize:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		contentType:
		type: string
		userAgent:
		type: string
		userIdentity:
		type: string
		referer:
		$ref: '#/components/schemas/AbsoluteUrl'
		cacheStatus:
		$ref: '#/components/schemas/CacheStatus'
		responseMessage:
		type: object
		required:
		- responseCode
		- size
		- bodySize
		properties:
		responseCode:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		size:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		bodySize:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
		contentType:
		type: string
		processingLatency:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
		connectionMetrics:
		type: object
		required:
		- meanNetworkRoundTripTime
		- networkRoundTripTimeVariation
		- congestionWindowSize
		properties:
		meanNetworkRoundTripTime:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
		networkRoundTripTimeVariation:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
		congestionWindowSize:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

		NetworkAssistanceInvocation:
		description: Common properties of a single Network Assistance invocation.
		type: object
		properties:
		policyTemplateId:
		$ref: '#/components/schemas/ResourceId'
		serviceDataFlowDescriptions:
		type: array
		minItems: 1
		items:
		$ref: '#/components/schemas/ServiceDataFlowDescription'
		requestedQoS:
		$ref: '#/components/schemas/UnidirectionalQoSSpecification'
		# The network QoS parameters (if any) requested by the Media Session Handler.
		recommendedQoS:
		type: object
		description: The network QoS parameters (if any) recommended to the Media Session Handler.
		required:
		- maximumBitRate
		- minimumBitRate
		properties:
		maximumBitRate:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		minimumBitRate:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'

		UnidirectionalQoSSpecification:
		type: object
		description: A specification for network Quality of Service in either the downlink or uplink direction.
		required:
		- maximumRequestedBitRate
		- minimumRequestedBitRate
		properties:
		maximumRequestedBitRate:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		minimumDesiredBitRate:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		minimumRequestedBitRate:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		desiredPacketLatency:
		type: integer
		minimum: 0
		desiredPacketLossRate:
		type: integer
		minimum: 0

		#####################################
		# Clause 6.4.4: Enumerated data types
		#####################################

TS26512_EventExposure.yaml

0 → 100644

+300 −0

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: 5GMS Event Exposure
		version: 1.0.0
		description: \|
		5GMS Event Exposure syntax
		© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.
		tags:
		- name: 5GMS Event Exposure
		description: '5G Media Streaming: Event Exposure'
		externalDocs:
		description: 'TS 26.512 V18.0.0; 5G Media Streaming (5GMS); Protocols'
		url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
		paths: {}
		components:
		schemas:
		BaseEventCollection:
		type: object
		description: Abstract base data type describing a collection of event records
		required:
		- collectionTimestamp
		- startTimestamp
		- endTimestamp
		- sampleCount
		- streamingDirection
		- summarisations
		- records
		properties:
		collectionTimestamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		# The date–time at which this collection was exposed by the Data Collection AF as an event to its subscribed event consumers.
		startTimestamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		# Date–time of earliest data sample included in or summarised by this collection.
		endTimestamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		# Date–time of latest data sample included in or summarised by this collection.
		sampleCount:
		type: integer
		minimum: 1
		description: The number of data samples included in or summarised by this collection.
		streamingDirection:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/ProvisioningSessionType'
		summarisations:
		type: array
		minItems: 1
		items:
		$ref: 'TS26532_Ndcaf_DataReportingProvisioning.yaml#/components/schemas/DataAggregationFunctionType'
		description: One or more data aggregation functions that have been applied to the UE data to produce summary records present in this collection.
		records:
		type: array
		minItems: 0
		items: {}
		description: Type of record is defined by concrete data type.

		BaseEventRecord:
		type: object
		description: Abstract base data type describing a single UE data record or summarising a set of UE data records.
		required:
		- recordType
		- recordTimestamp
		properties:
		recordType:
		$ref: '#/components/schemas/EventRecordType'
		recordTimestamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		# The date–time at which the UE data carried in this record was sampled or summarised.
		provisioningSessionId:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'
		# The identifier of the Provisioning Session to which this record pertains. Present only for individual data sample record type.
		sessionId:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/MediaDeliverySessionId'
		# A value synthesised by the 5GMS System that uniquely identifies the media streaming session to which this record pertains. Present only for individual data sample record type.
		ueIdentification:
		type: string
		description: GPSI of the requesting UE or a stable globally unique string identifying the requesting Media Session Handler. Present only for individual data sample record type and only when exposure is permitted by the data exposure restrictions in force for the event type in question.
		dataNetworkName:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
		# Identifying the Data Network of the M4 media streaming session. Present only for individual data sample record type.
		sliceId:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
		# The S-NSSAI identifying the Network Slice of the M4 media streaming session. Present only for individual data sample record type.
		ueLocations:
		type: array
		minItems: 0
		items:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
		description: The location of the UE when the data described by this record was sampled. Present only for individual data sample record type and only when exposure is permitted by the data exposure restrictions in force for the event in question.

		EventRecordType:
		description: Enumeration of event record types.
		anyOf:
		- type: string
		enum: [INDIVIDUAL_SAMPLE, SUMMARY_MEAN, SUMMARY_MINIMUM, SUMMARY_MAXIMUM, SUMMARY_SUM]
		- 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.

		QoEMetricsCollection:
		description: A collection of QoE Metrics Event records.
		allOf:
		- $ref: '#/components/schemas/BaseEventCollection'
		- type: object
		required:
		- records
		properties:
		records:
		type: array
		minItems: 0
		items:
		$ref: '#/components/schemas/QoEMetricsEvent'
		description: A set of QoE Metrics Event records, each one describing a QoE metrics report or summarising a set of QoE metrics reports.

		QoEMetricsEvent:
		description: A QoE Metrics Event record.
		allOf:
		- $ref: '#/components/schemas/BaseEventRecord'
		- type: object
		required:
		- metricType
		properties:
		metricType:
		$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
		# A fully-qualified term identifier that uniquely identifies the QoE metrics reporting scheme and the type of QoE metric included in this record, as specified in clause E.2, up to but excluding the first hierarchical separator.
		samples:
		type: array
		minItems: 1
		items:
		type: object
		required:
		- metrics
		properties:
		sampleTimestamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		# The moment in time at which this QoE metric was sampled.
		sampleDuration:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/Duration'
		# The time duration over which this QoE metric was sampled.
		mediaTimestamp:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/Duration'
		# The time point in the media at which this QoE metric was sampled.
		metrics:
		type: array
		minItems: 1
		description: A set of key–value pairs for the samples metrics associated with this QoE metric sample.
		items:
		type: object
		description: A name and optional value for a QoE metric within a QoE metric sample.
		required:
		- key
		properties:
		key:
		type: string
		description: A token that uniquely identifies the type of metric within the scope of the event type.
		value: {}

		ConsumptionReportingUnitsCollection:
		description: A collection of Consumption Reporting Event records.
		allOf:
		- $ref: '#/components/schemas/BaseEventCollection'
		- type: object
		required:
		- records
		properties:
		records:
		type: array
		minItems: 0
		items:
		$ref: '#/components/schemas/ConsumptionReportingEvent'
		description: A set of records, each one describing a Consumption Reporting Unit.

		ConsumptionReportingEvent:
		description: A Consumption Reporting Event record, corresponding to a Consumption Reporting Unit.
		allOf:
		- $ref: '#/components/schemas/BaseEventRecord'
		- type: object
		required:
		- unitDuration
		- mediaPlayerEntryUrl
		- mediaComponentIdentifier
		properties:
		unitDuration:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/Duration'
		# The duration of this consumption reporting unit.
		clientEndpointAddress:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress'
		# The endpoint address of the UE that consumed media.
		serverEndpointAddress:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/EndpointAddress'
		# The endpoint address of the 5GMS AS from which media was consumed.
		mediaPlayerEntryUrl:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/AbsoluteUrl'
		# The Media Player Entry URL to which this consumption reporting unit pertains.
		mediaComponentIdentifier:
		type: string
		description: A token (e.g., an MPEG DASH representation identifier) identifying the media component of the Media Player Entry that was consumed during this consumption reporting unit.

		NetworkAssistanceInvocationsCollection:
		description: A collection of Network Assistance Invocation Event records.
		allOf:
		- $ref: '#/components/schemas/BaseEventCollection'
		- type: object
		required:
		- records
		properties:
		records:
		type: array
		minItems: 0
		items:
		$ref: '#/components/schemas/NetworkAssistanceInvocationEvent'
		description: A set of records, each one describing a Network Assistance invocation or summarising a set of Network Assistance invocations.

		NetworkAssistanceInvocationEvent:
		description: A Network Assistance Invocation Event record.
		allOf:
		- $ref: '#/components/schemas/BaseEventRecord'
		- type: object
		required:
		- networkAssistanceType
		properties:
		networkAssistanceType:
		$ref: '#/components/schemas/NetworkAssistanceType'
		# The type of Network Assistance solicited by the Media Session Handler.
		- $ref: 'TS26512_CommonData.yaml#/components/schemas/NetworkAssistanceInvocation'

		NetworkAssistanceType:
		description: The type of network assistance sought by the Media Session Handler.
		anyOf:
		- type: string
		enum: [AF_THROUGHPUT_ESTIMATION, AF_DELIVERY_BOOST, ANBR_THROUGHPUT_ESTIMATION, ANBR_DELIVERY_BOOST]
		- 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.

		DynamicPolicyInvocationsCollection:
		description: A collection of Dynamic Policy Invocation Event records.
		allOf:
		- $ref: '#/components/schemas/BaseEventCollection'
		- type: object
		required:
		- records
		properties:
		records:
		type: array
		minItems: 0
		items:
		$ref: '#/components/schemas/DynamicPolicyInvocationEvent'
		description: A set of records, each one describing a dynamic policy invocation.

		DynamicPolicyInvocationEvent:
		description: A Dynamic Policy Invocation Event record.
		allOf:
		- $ref: '#/components/schemas/BaseEventRecord'
		- type: object
		required:
		- policyTemplateId
		properties:
		policyTemplateId:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/ResourceId'
		serviceDataFlowDescriptions:
		type: array
		minItems: 1
		items:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/ServiceDataFlowDescription'
		description: The set of Service Data Flows to which the Media Session Handler requested that the Policy Template be applied. At least a domain name or one packet filter shall be present.
		requestedQoS:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/UnidirectionalQoSSpecification'
		# The network QoS parameters (if any) requested by the Media Session Handler.
		enforcementMethod:
		type: string
		description: The policy enforcement method chosen by the 5GMS AF.
		enforcementBitRate:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
		# The enforcement bit rate (if any) selected by the 5GMS AF.

		MediaStreamingAccessesCollection:
		description: A collection of Media Streaming Access Event records.
		allOf:
		- $ref: '#/components/schemas/BaseEventCollection'
		- type: object
		required:
		- records
		properties:
		records:
		type: array
		minItems: 0
		items:
		$ref: '#/components/schemas/MediaStreamingAccessEvent'
		description: A set of records, each one describing one media streaming access.

		MediaStreamingAccessEvent:
		description: A Media Streaming Access Event record.
		allOf:
		- $ref: '#/components/schemas/BaseEventRecord'
		- $ref: 'TS26512_CommonData.yaml#/components/schemas/MediaStreamingAccess'

TS26512_M1_ConsumptionReportingProvisioning.yaml

+7 −4

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: M1_ConsumptionReportingProvisioning
		version: 2.0.1
		version: 2.1.0
		description: \|
		5GMS AF M1 Consumption Reporting Provisioning API
		© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -10,7 +10,7 @@ tags:
		- name: M1_ConsumptionReportingProvisioning
		description: '5G Media Streaming: Provisioning (M1) APIs: Consumption Reporting Provisioning'
		externalDocs:
		description: 'TS 26.512 V17.4.0; 5G Media Streaming (5GMS); Protocols'
		description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols'
		url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
		servers:
		- url: '{apiRoot}/3gpp-m1/v2'
		@@ -108,7 +108,10 @@ components:
		description: "A representation of a Consumption Reporting Configuration resource."
		properties:
		reportingInterval:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		minimum: 0
		exclusiveMinimum: true
		allOf:
		- $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
		samplePercentage:
		$ref: 'TS26512_CommonData.yaml#/components/schemas/Percentage'
		locationReporting:

TS26512_M1_ContentHostingProvisioning.yaml

+5 −9

Original line number	Diff line number	Diff line
		openapi: 3.0.0
		info:
		title: M1_ContentHostingProvisioning
		version: 2.2.2
		version: 2.2.3
		description: \|
		5GMS AF M1 Content Hosting Provisioning API
		© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		@@ -10,7 +10,7 @@ tags:
		- name: M1_ContentHostingProvisioning
		description: '5G Media Streaming: Provisioning (M1) APIs: Content Hosting Provisioning'
		externalDocs:
		description: 'TS 26.512 V17.6.0; 5G Media Streaming (5GMS); Protocols'
		description: 'TS 26.512 V17.7.0; 5G Media Streaming (5GMS); Protocols'
		url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
		servers:
		- url: '{apiRoot}/3gpp-m1/v2'
		@@ -138,6 +138,9 @@ paths:
		'204':
		# No Content
		description: 'No Content Purged'
		'400':
		# Bad Request (e.g. syntactically invalid regular expression in request body)
		$ref: 'TS29571_CommonData.yaml#/components/responses/400'
		'404':
		# Not Found
		$ref: 'TS29571_CommonData.yaml#/components/responses/404'
		@@ -150,13 +153,6 @@ paths:
		'415':
		# Unsupported Media Type
		$ref: 'TS29571_CommonData.yaml#/components/responses/415'
		'422':
		# Unprocessable Entity (e.g. syntactically invalid regular expression in request body)
		description: 'Unprocessable Entity'
		content:
		application/problem+json:
		schema:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
		'500':
		# Internal Server Error
		$ref: 'TS29571_CommonData.yaml#/components/responses/500'

TS26512_M1_ContentPreparationTemplatesProvisioning.yaml

+21 −3

File changed.

Preview size limit exceeded, changes collapsed.