Skip to content
Commits on Source (23)
# OpenAPI Specification Files for 3GPP 5G Core Network (Release 18)
# {-[DRAFT]-} OpenAPI Specification Files for 3GPP 5G Core Network (Release 18)
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.
API version: **June 2024**
API version: **October/November 2024**
Release status: **{- Frozen -}**
Other releases: [Rel-19 (Open)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-19), [Rel-17 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-17), [Rel-16 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-16), [Rel-15 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-15)
OpenAPI validation status:
[![pipeline status](https://forge.3gpp.org/rep/all/5G_APIs/badges/REL-18/pipeline.svg)](https://forge.3gpp.org/rep/all/5G_APIs/commits/REL-18)
[![pipeline status](https://forge.3gpp.org/rep/all/5G_APIs/badges/Rel18-draft-TSG106/pipeline.svg)](https://forge.3gpp.org/rep/all/5G_APIs/commits/Rel18-draft-TSG106)
#### Tools
* <a href="https://forge.3gpp.org/swagger/tools/parser.html">API Parser/Linter</a> to parse OpenAPI files with APIDevTools Swagger Parser/Validator and run a number of <a href="https://en.wikipedia.org/wiki/Lint_(software)" target="_blank">lint</a> rules to improve API quality
......
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: ETC_Configuration
version: 1.0.0
version: 1.0.1
description: |
API for event triggered network slice adaptation configuration.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 24.549 V18.2.0 Application Data Analytics Enablement Service; Stage 3.
3GPP TS 24.549 V18.3.0 Application Data Analytics Enablement Service; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.549/
security:
......@@ -120,8 +120,3 @@ components:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea'
ratType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
preservIpAdd:
description: >
Indication whether to preserve the UE IP address (true) or not (false).
type: boolean
default: false
openapi: 3.0.0
info:
title: Eees Application Context Relocation Service
version: "1.1.0"
version: "1.1.1"
description: |
Eees Application Context Relocation Service.
© 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 24.558 V18.5.1; Enabling Edge Applications; Protocol specification; Stage 3.
3GPP TS 24.558 V18.6.0; Enabling Edge Applications; Protocol specification; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/24.558/'
servers:
......@@ -254,6 +254,12 @@ components:
items:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
minItems: 1
requestorId:
description: >
Contains the identifier of the EAS that is sending the request. It shall be
included although it is not specified as a mandatory due to backward
compatibility reasons.
type: string
required:
- ueId
- tEasId
......
<?xml version="1.0"?>
<xs:schema version="TSG104-Rel18" xmlns:xs="http://www.w3.org/2001/XMLSchema"
<xs:schema version="TSG105-Rel18" xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="urn:3gpp:metadata:2017:HSD:receptionreport"
xmlns:sup="urn:3gpp:metadata:2016:PSS:SupplementQoEMetric"
xmlns:rtc="urn:3gpp:metadata:2023:RTC:QoEMetrics"
......@@ -18,6 +18,7 @@
<xs:complexType name="ReceptionReportType">
<xs:sequence>
<xs:element ref="sv:schemaVersion"/>
<xs:element name="QoeReport" type="QoeReportType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="sv:delimiter"/>
<xs:any namespace="##other" processContents="skip" minOccurs="0" maxOccurs="unbounded"/>
......
openapi: 3.0.0
info:
title: 'Media Delivery: Common Data Types'
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Common Data Types
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Common Data Types'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
paths: {}
......@@ -49,6 +49,7 @@ components:
type: string
format: duration
description: 'String with format "duration" as defined by JSON Schema (referencing IETF RFC 3339, appendix A and, ultimately, ISO 8601).'
#Date is defined in TS29571_CommonData
#DateTime is defined in TS29571_CommonData
#Uri is defined in TS29571_CommonData
Url:
......@@ -113,7 +114,7 @@ components:
mediaTransportParameters:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProtocolDescription'
M1UnidirectionalQoSSpecification:
UnidirectionalQoSSpecification:
type: object
required:
- maximumBitRate
......@@ -124,12 +125,12 @@ components:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maximumAuthorisedBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
defaultPacketLossRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
minimumPacketLossRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
pduSetQosLimits:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara'
M1QoSSpecification:
QosRange:
type: object
required:
- componentReference
......@@ -144,14 +145,14 @@ components:
qosReference:
type: string
downlinkQoSSpecification:
$ref: '#/components/schemas/M1UnidirectionalQoSSpecification'
$ref: '#/components/schemas/UnidirectionalQosSpecification'
uplinkQoSSpecification:
$ref: '#/components/schemas/M1UnidirectionalQoSSpecification'
$ref: '#/components/schemas/UnidirectionalQosSpecification'
pduSetMarking:
type: boolean
default: false
M5BitRateSpecification:
UnidirectionalBitRateSpecification:
type: object
required:
- maximumRequestedBitRate
......@@ -165,16 +166,16 @@ components:
minimumRequestedBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
M5QoSSpecification:
ClientQosSpecification:
type: object
required:
- downlinkBitRates
- uplinkBitRates
properties:
downlinkBitRates:
$ref: '#/components/schemas/M5BitRateSpecification'
$ref: '#/components/schemas/UnidirectionalBitRateSpecification'
uplinkBitRates:
$ref: '#/components/schemas/M5BitRateSpecification'
$ref: '#/components/schemas/UnidirectionalBitRateSpecification'
desiredPacketLatency:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
desiredPacketLossRate:
......@@ -256,7 +257,7 @@ components:
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'
UnidirectionalQoSSpecification:
UnidirectionalQosSpecification:
type: object
description: A specification for network Quality of Service in either the downlink or uplink direction.
required:
......@@ -274,8 +275,8 @@ components:
desiredPacketLossRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
M1MediaEntryPoint:
description: "A typed entry point for downlink or uplink media streaming."
RelativeMediaEntryPoint:
description: "A typed entry point for downlink or uplink media streaming expressed relative to some base URL signalled elsewhere."
type: object
required:
- relativePath
......@@ -321,7 +322,7 @@ components:
maxAge:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
BDTWindow:
BdtWindow:
type: object
description: 'A window in time during which Background Data Transfer is possible with a particular bit rate in the downlink and/or uplink direction.'
required:
......
openapi: 3.0.0
info:
title: Maf_Provisioning_ContentHosting
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Content Hosting Provisioning API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Content Hosting Provisioning API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......@@ -366,7 +366,7 @@ components:
allOf:
- $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'
entryPoint:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M1MediaEntryPoint'
$ref: 'TS26510_CommonData.yaml#/components/schemas/RelativeMediaEntryPoint'
pathRewriteRules:
type: array
items:
......
openapi: 3.0.0
info:
title: Maf_Provisioning_ContentPublishing
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Content Publishing Provisioning API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Content Publishing Provisioning API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......@@ -321,7 +321,7 @@ components:
baseURL:
$ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'
entryPoint:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M1MediaEntryPoint'
$ref: 'TS26510_CommonData.yaml#/components/schemas/RelativeMediaEntryPoint'
cachingConfigurations:
type: array
items:
......@@ -356,7 +356,7 @@ components:
allOf:
- $ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'
entryPoint:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M1MediaEntryPoint'
$ref: 'TS26510_CommonData.yaml#/components/schemas/RelativeMediaEntryPoint'
# Schema for the resource itself
ContentPublishingConfiguration:
......
......@@ -309,6 +309,29 @@ components:
exclusiveMinimum: true
allOf:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
positiveCrossingThresholds:
description: "A map (list of key-value pairs) for a metric and its positive crossing threshold values. The key of the map shall be a metric URI."
type: object
additionalProperties:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
minItems: 1
minProperties: 1
negativeCrossingThresholds:
description: "A map (list of key-value pairs) for a metric and its negative crossing threshold values. The key of the map shall be a metric URI."
type: object
additionalProperties:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
minItems: 1
minProperties: 1
locationFilter:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
minItems: 1
metrics:
type: array
items:
......
openapi: 3.0.0
info:
title: Maf_Provisioning_PolicyTemplates
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Policy Templates Provisioning API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Policy Templates Provisioning API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......@@ -318,24 +318,24 @@ components:
type: array
minItems: 1
items:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M1QoSSpecification'
$ref: 'TS26510_CommonData.yaml#/components/schemas/QosRange'
chargingSpecification:
$ref: 'TS26510_CommonData.yaml#/components/schemas/ChargingSpecification'
bdtPolicyId:
$ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId'
bdtSpecification:
$ref: '#/components/schemas/M1BDTSpecification'
$ref: '#/components/schemas/BdtPolicySchedule'
M1BDTSpecification:
BdtPolicySchedule:
type: object
description: "Background Data Transfer policy schedule specification."
required:
- windows
properties:
startDate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
$ref: 'TS29571_CommonData.yaml#/components/schemas/Date'
endDate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
$ref: 'TS29571_CommonData.yaml#/components/schemas/Date'
windows:
type: object
properties:
......
openapi: 3.0.0
info:
title: Maf_Provisioning_RealTimeCommunication
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Real-Time media Communication Provisioning API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Real-Time media Communication Provisioning API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......@@ -261,7 +261,7 @@ components:
type: array
minItems: 1
items:
$ref: '#/components/schemas/M1EndpointAccess'
$ref: '#/components/schemas/ServiceEndpointAccessSpecification'
enableTurnService:
type: boolean
default: false
......@@ -269,7 +269,7 @@ components:
type: array
minItems: 1
items:
$ref: '#/components/schemas/M1EndpointAccess'
$ref: '#/components/schemas/ServiceEndpointAccessSpecification'
enableSwapService:
type: boolean
default: false
......@@ -277,9 +277,9 @@ components:
type: array
minItems: 1
items:
$ref: '#/components/schemas/M1EndpointAccess'
$ref: '#/components/schemas/ServiceEndpointAccessSpecification'
M1EndpointAccess:
ServiceEndpointAccessSpecification:
type: object
description: "Access details used for provisioning a service endpoint."
allOf:
......
openapi: 3.0.0
info:
title: Maf_SessionHandling_DynamicPolicy
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Dynamic Policy API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Dynamic Policy API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......@@ -308,7 +308,7 @@ components:
$ref: '#/components/schemas/ApplicationFlowBinding'
minItems: 1
bdtSpecification:
$ref: '#/components/schemas/M5BDTSpecification'
$ref: '#/components/schemas/ClientBdtSpecification'
qosEnforcement:
readOnly: true
type: boolean
......@@ -325,9 +325,9 @@ components:
applicationFlowDescription:
$ref: 'TS26510_CommonData.yaml#/components/schemas/ApplicationFlowDescription'
qosSpecification:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M5QoSSpecification'
$ref: 'TS26510_CommonData.yaml#/components/schemas/ClientQosSpecification'
M5BDTSpecification:
ClientBdtSpecification:
description: "A client-facing set of Background Data Transfer bids/grants."
type: object
required:
......@@ -339,4 +339,4 @@ components:
type: array
minItems: 1
items:
$ref: 'TS26510_CommonData.yaml#/components/schemas/BDTWindow'
$ref: 'TS26510_CommonData.yaml#/components/schemas/BdtWindow'
openapi: 3.0.0
info:
title: Maf_SessionHandling_NetworkAssistance
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Network Assistance API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Network Assistance API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......@@ -276,7 +276,7 @@ paths:
content:
application/json:
schema:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M5QoSSpecification'
$ref: 'TS26510_CommonData.yaml#/components/schemas/ClientQosSpecification'
'400': # Bad Request: The syntax of the HTTP request is malformed in a way not covered by one of the following more specific client errors
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401': # Unauthorized
......@@ -406,8 +406,8 @@ components:
applicationFlowDescription:
$ref: 'TS26510_CommonData.yaml#/components/schemas/ApplicationFlowDescription'
requestedQoS:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M5QoSSpecification'
$ref: 'TS26510_CommonData.yaml#/components/schemas/ClientQosSpecification'
recommendedQoS:
readOnly: true
allOf:
- $ref: 'TS26510_CommonData.yaml#/components/schemas/M5QoSSpecification'
- $ref: 'TS26510_CommonData.yaml#/components/schemas/ClientQosSpecification'
openapi: 3.0.0
info:
title: Maf_SessionHandling_ServiceAccessInformation
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Service Access Information API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Service Access Information API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......@@ -83,7 +83,7 @@ components:
service-access-information-retreive: Retrieve Service Access Information resource
schemas:
M5MediaEntryPoint:
AbsoluteMediaEntryPoint:
description: "A typed entry point for downlink or uplink media streaming."
type: object
required:
......@@ -136,7 +136,7 @@ components:
entryPoints:
type: array
items:
$ref: '#/components/schemas/M5MediaEntryPoint'
$ref: '#/components/schemas/AbsoluteMediaEntryPoint'
eMBMSServiceAnnouncementLocator:
$ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'
mbsExternalServiceIdentifier:
......@@ -148,17 +148,17 @@ components:
type: array
minItems: 1
items:
$ref: '#/components/schemas/M5EndpointAccess'
$ref: '#/components/schemas/ClientServiceEndpointAccessParameters'
turnEndpoints:
type: array
minItems: 1
items:
$ref: '#/components/schemas/M5EndpointAccess'
$ref: '#/components/schemas/ClientServiceEndpointAccessParameters'
swapEndpoints:
type: array
minItems: 1
items:
$ref: '#/components/schemas/M5EndpointAccess'
$ref: '#/components/schemas/ClientServiceEndpointAccessParameters'
clientConsumptionReportingConfiguration:
type: object
required:
......@@ -203,7 +203,7 @@ components:
type: array
minItems: 1
items:
$ref: 'TS26510_CommonData.yaml#/components/schemas/BDTWindow'
$ref: 'TS26510_CommonData.yaml#/components/schemas/BdtWindow'
sdfMethods:
type: array
items:
......@@ -250,6 +250,29 @@ components:
minItems: 0
samplingPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
positiveCrossingThresholds:
description: "A map (list of key-value pairs) for a metric and its positive crossing threshold values. The key of the map shall be a metric URI."
type: object
additionalProperties:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
minItems: 1
minProperties: 1
negativeCrossingThresholds:
description: "A map (list of key-value pairs) for a metric and its negative crossing threshold values. The key of the map shall be a metric URI."
type: object
additionalProperties:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
minItems: 1
minProperties: 1
locationFilter:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
minItems: 1
metrics:
type: array
items:
......@@ -272,9 +295,9 @@ components:
easDiscoveryTemplate:
$ref: '#/components/schemas/EASDiscoveryTemplate'
easRelocationRequirements:
$ref: '#/components/schemas/M5EASRelocationRequirements'
$ref: '#/components/schemas/ClientEASRelocationRequirements'
M5EndpointAccess:
ClientServiceEndpointAccessParameters:
type: object
description: "Details used by a Media Client to access a service endpoint."
allOf:
......@@ -294,7 +317,7 @@ components:
type: string
minLength: 1
M5EASRelocationRequirements:
ClientEASRelocationRequirements:
description: 'Relocation requirements of an EAS.'
type: object
required:
......@@ -331,30 +354,3 @@ components:
type: string
minLength: 1
minItems: 1
NotificationMessage:
description: 'A message sent by the Media AF on an MQTT notification channel.'
type: object
properties:
type:
$ref: '#/components/schemas/NotificationMessageType'
serviceAccessInformation:
$ref: '#/components/schemas/ServiceAccessInformationResource'
dynamicPolicy:
$ref: 'TS26510_Maf_SessionHandling_DynamicPolicy.yaml#/components/schemas/DynamicPolicy'
networkAssistanceSession:
$ref: 'TS26510_Maf_SessionHandling_NetworkAssistance.yaml#/components/schemas/NetworkAssistanceSession'
NotificationMessageType:
description: 'Enumeration of notification message types.'
anyOf:
- type: string
enum:
- NOTIFICATION_SERVICE_ACCESS_INFORMATION
- NOTIFICATION_DYNAMIC_POLICY_INSTANCE
- NOTIFICATION_NETWORK_ASSISTANCE_SESSION
- 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.
openapi: 3.0.0
info:
title: 'Media Delivery: Notifications'
version: 1.0.0
description: |
Media Delivery: Notifications
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
tags:
- name: 'Media Delivery: Notifications'
description: 'Media Delivery: Asynchronous MQTT notifications sent by the Media AF at reference points M3 and M5'
externalDocs:
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
paths: {}
components:
schemas:
NotificationMessage:
description: 'A message sent by the Media AF on an MQTT notification channel.'
type: object
required:
- type
oneOf:
- required: [serviceAccessInformation]
- required: [dynamicPolicy]
- required: [networkAssistanceSession]
properties:
type:
$ref: '#/components/schemas/NotificationMessageType'
entityTag:
type: string
minLength: 1
lastModified:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
serviceAccessInformation:
$ref: 'TS26510_Maf_SessionHandling_ServiceAccessInformation.yaml#/components/schemas/ServiceAccessInformationResource'
dynamicPolicy:
$ref: 'TS26510_Maf_SessionHandling_DynamicPolicy.yaml#/components/schemas/DynamicPolicy'
networkAssistanceSession:
$ref: 'TS26510_Maf_SessionHandling_NetworkAssistance.yaml#/components/schemas/NetworkAssistanceSession'
NotificationMessageType:
description: 'Enumeration of notification message types.'
anyOf:
- type: string
enum:
- NOTIFICATION_SERVICE_ACCESS_INFORMATION
- NOTIFICATION_DYNAMIC_POLICY_INSTANCE
- NOTIFICATION_NETWORK_ASSISTANCE_SESSION
- 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.
openapi: 3.0.0
info:
title: M5_DynamicPolicies
version: 3.0.0
version: 3.0.1
description: |
5GMS AF M5 Dynamic Policy API (deprecated)
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Media Session Handling (M5) APIs: Dynamic Policies (deprecated)'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.3.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
paths: {}
......@@ -42,7 +42,7 @@ components:
provisioningSessionId:
$ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'
qosSpecification:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M5QoSSpecification'
$ref: 'TS26510_CommonData.yaml#/components/schemas/ClientQosSpecification'
enforcementMethod:
type: string
enforcementBitRate:
......
openapi: 3.0.0
info:
title: M5_NetworkAssistance
version: 3.0.0
version: 3.0.1
description: |
5GMS AF M5 Network Assistance API (deprecated)
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: '5G Media Streaming: Media Session Handling (M5) APIs: Network Assistance (deprecated)'
externalDocs:
description: 'TS 26.512 V18.2.0; 5G Media Streaming (5GMS); Protocols'
description: 'TS 26.512 V18.3.0; 5G Media Streaming (5GMS); Protocols'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.512/'
paths: {}
......@@ -42,8 +42,8 @@ components:
policyTemplateId:
$ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'
requestedQoS:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M5QoSSpecification'
$ref: 'TS26510_CommonData.yaml#/components/schemas/ClientQosSpecification'
recommendedQoS:
$ref: 'TS26510_CommonData.yaml#/components/schemas/M5QoSSpecification'
$ref: 'TS26510_CommonData.yaml#/components/schemas/ClientQosSpecification'
notficationURL:
$ref: 'TS26510_CommonData.yaml#/components/schemas/AbsoluteUrl'
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: 'MBS User Service Announcement'
version: 2.0.0
version: 2.0.1
description: |
MBS User Service Announcement Element units.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 26.517 V18.1.0; 5G Multicast-Broadcast User Services; Protocols and Formats
description: 3GPP TS 26.517 V18.2.0; 5G Multicast-Broadcast User Services; Protocols and Formats
url: http://www.3gpp.org/ftp/Specs/archive/26_series/26.517/
paths:
/user-service-descriptions:
......@@ -225,8 +225,6 @@ components:
minItems: 1
nrRedCapUEInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NrRedCapUeInfo'
required:
- nrParameters
NrParameterSet:
type: object
......
openapi: 3.0.0
info:
title: Data Collection and Reporting Common Data Types
version: 2.0.0
version: 2.1.0
description: |
Data Collection and Reporting Common Data Types
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ tags:
- name: Data Collection and Reporting Common Data Types
description: 'Data Collection and Reporting: Common Data Types'
externalDocs:
description: 'TS 26.532 V18.2.0; Data Collection and Reporting; Protocols and Formats'
description: 'TS 26.532 V18.3.0; Data Collection and Reporting; Protocols and Formats'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.532/'
paths: {}
components:
......@@ -27,15 +27,30 @@ components:
description: "Instructions on how UE data is to be sampled by the data collection client."
type: object
properties:
contextIds:
readOnly: true
type: array
minItems: 1
items:
type: string
minLength: 1
samplingPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
locationFilter:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
required:
- contextIds
DataReportingCondition:
description: "A condition that triggers data reporting by a data collection client to the Data Collection AF."
type: object
properties:
contextIds:
type: array
minItems: 1
items:
type: string
minLength: 1
type:
$ref: '#/components/schemas/DataReportingConditionType'
period:
......@@ -57,12 +72,19 @@ components:
eventTrigger:
$ref: '#/components/schemas/DataReportingEventTrigger'
required:
- contextIds
- type
DataReportingRule:
description: "Instructions on how collected UE data is to be reported by the data collection client to the Data Collection AF."
type: object
properties:
contextIds:
type: array
minItems: 1
items:
type: string
minLength: 1
reportingProbability:
$ref: 'TS26510_CommonData.yaml#/components/schemas/Percentage'
reportingFormat:
......@@ -70,6 +92,8 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
dataPackagingStrategy:
type: string
required:
- contextIds
#####################################
# Clause 5.4.3: Enumerated data types
......
openapi: 3.0.0
info:
title: Ndcaf_DataReporting
version: 2.0.0
version: 2.1.0
description: |
Data Collection AF: Data Collection and Reporting Configuration API and Data Reporting API
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -12,7 +12,7 @@ tags:
description: 'Data Collection and Reporting: Client Configuration and Data Reporting (R2/R3/R4) APIs'
externalDocs:
description: 'TS 26.532 V18.2.0; Data Collection and Reporting; Protocols and Formats'
description: 'TS 26.532 V18.3.0; Data Collection and Reporting; Protocols and Formats'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.532/'
servers:
......@@ -336,8 +336,14 @@ components:
properties:
timestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
contextIds:
type: array
minItems: 1
items:
type: string
required:
- timestamp
- contextIds
ServiceExperienceRecord:
description: "A data reporting record for UE service experience."
......
openapi: 3.0.1
info:
title: MDA NRM
version: 18.4.0
version: 18.5.0
description: >-
OAS 3.0.1 specification of the MDA NRM
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -107,6 +107,7 @@ components:
format: float
minimum: 0
#-------- Definition of types for name-containments ------
SubNetwork-ncO-MdaNrm:
type: object
......@@ -138,15 +139,17 @@ components:
properties:
supportedMDACapabilities:
$ref: '#/components/schemas/MDATypes'
mlModelRef:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
aIMLInferenceFunctionRef:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn'
mLModelRefList:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
aIMLInferenceFunctionRefList:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList'
- $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO'
- type: object
properties:
MDARequest:
$ref: '#/components/schemas/MDARequest-Multiple'
MDAReport:
$ref: '#/components/schemas/MDAReport-Multiple'
MDARequest-Single:
allOf:
......