Skip to content
Show whitespace changes
Inline Side-by-side
TS29548_SDD_DataStorage.yaml
View file @ 1a359940
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: SEALDD Server Data Storage Service
version: 1.1.0-alpha.1
version: 1.1.0-alpha.2
description: |
SEALDD Server Data Storage Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.548 V19.1.0; Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.548 V19.3.0; Service Enabler Architecture Layer for Verticals (SEAL);
SEAL Data Delivery (SEALDD) Server Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/
......@@ -1033,7 +1033,7 @@ components:
application data in different SEALDD Servers.
This identifier shall be generated either based on the identifier of the service consumer
that assigns it or using the Universally Unique Identifier (UUID) version 4 as described in
IETF RFC 4122.
IETF RFC 9562.
type: string
......
TS29548_SDD_PolicyConfiguration.yaml
View file @ 1a359940
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: SEALDD Server Policy Configuration Service
version: 1.1.0-alpha.1
version: 1.1.0-alpha.2
description: |
SEALDD Server Policy Configuration Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.548 V19.1.0; Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.548 V19.3.0; Service Enabler Architecture Layer for Verticals (SEAL);
SEAL Data Delivery (SEALDD) Server Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/
......@@ -283,6 +283,8 @@ components:
minItems: 1
valTargetId:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
sliceId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
sealddPol:
$ref: '#/components/schemas/SealddPolicy'
expTime:
......@@ -396,8 +398,26 @@ components:
Represents a Multi-modal SEALDD Policy.
type: object
properties:
syncPol:
type: array
items:
$ref: '#/components/schemas/SyncPolicy'
minItems: 1
description: >
Contains the synchronization policy.
The key of the map shall be set to the multi-modal flow type provided within the
"flowType" attribute of the corresponding map value encoded using the SyncPolicy data
structure.
alignmentPol:
$ref: '#/components/schemas/AlignmentPolicy'
ueToUePol:
$ref: '#/components/schemas/UEToUEPolicy'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo'
anyOf:
- required: [syncPol]
- required: [alignmentPol]
- required: [ueToUePol]
TempPolicy:
description: >
......@@ -432,6 +452,8 @@ components:
minItems: 1
thrHandling:
$ref: 'TS29549_SS_NetworkResourceMonitoring.yaml#/components/schemas/ThresholdHandlingMode'
timeThr:
$ref: '#/components/schemas/TempPolicy'
anyOf:
- required: [accessIds]
- required: [thresholds]
......@@ -442,18 +464,9 @@ components:
Represents the signal strength value.
type: object
properties:
rsrp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
sinr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
rsrq:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
rssi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
anyOf:
- required: [rsrp]
- required: [sinr]
- required: [rsrq]
- required: [rssi]
SignalStrengthThreshold:
......@@ -469,6 +482,132 @@ components:
- value
- direction
SyncPolicy:
description: >
Represents the synchronization policy.
type: object
properties:
syncThreshold:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSec'
required:
- syncThreshold
AlignmentPolicy:
description: >
Represents the multi-modal flows alignment policy.
type: object
properties:
multiModalId:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId'
maxAlignTime:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/DurationMilliSec'
anyOf:
- required: [multiModalId]
- required: [maxAlignTime]
UEToUEPolicy:
description: >
Represents the multi-modal UE-to-UE policy.
type: object
properties:
proxThresh:
$ref: '#/components/schemas/ProximityThresholds'
qoSThresh:
$ref: '#/components/schemas/QoSThresholds'
qoEThresh:
$ref: '#/components/schemas/QoEThresholds'
anyOf:
- required: [proxThresh]
- required: [qoSThresh]
- required: [qoEThresh]
ProximityThresholds:
description: >
Represents the proximity thresholds for entering/leaving the UE-to-UE direct communication
mode.
type: object
properties:
minUeToUedist:
type: number
format: double
minimum: 0
avgUeToUedist:
type: number
format: double
minimum: 0
maxUeToUedist:
type: number
format: double
minimum: 0
anyOf:
- required: [minUeToUedist]
- required: [avgUeToUedist]
- required: [maxUeToUedist]
QoSThresholds:
description: >
Represents the QoS thresholds for entering/leaving the UE-to-UE direct communication mode.
type: object
properties:
minLatency:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
avgLatency:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
maxLatency:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
minBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
avgBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxBitRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
minPackLossRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
avgPackLossRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
maxPackLossRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
minPackErrRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
avgPackErrRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
maxPackErrRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
minJitter:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
avgJitter:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
maxJitter:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
anyOf:
- required: [minLatency]
- required: [avgLatency]
- required: [maxLatency]
- required: [minBitRate]
- required: [avgBitRate]
- required: [maxBitRate]
- required: [minPackLossRate]
- required: [avgPackLossRate]
- required: [maxPackLossRate]
- required: [minPackErrRate]
- required: [avgPackErrRate]
- required: [maxPackErrRate]
- required: [minJitter]
- required: [avgJitter]
- required: [maxJitter]
QoEThresholds:
description: >
Represents the QoE thresholds for entering/leaving the UE-to-UE direct communication mode.
type: object
properties:
mos:
type: integer
minimum: 1
maximum: 5
anyOf:
- required: [mos]
# SIMPLE DATA TYPES
#
......
TS29548_SDD_Transmission.yaml
View file @ 1a359940
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: SEALDD Server Data Transmission Service
version: 1.1.0-alpha.2
version: 1.1.0-alpha.3
description: |
SEALDD Server Data Transmission Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.548 V19.2.0; Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.548 V19.3.0; Service Enabler Architecture Layer for Verticals (SEAL);
SEAL Data Delivery (SEALDD) Server Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.548/
......@@ -384,20 +384,27 @@ components:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
valServerConnInfo:
$ref: '#/components/schemas/ConnInfo'
multiModalFlows:
type: array
items:
$ref: '#/components/schemas/MultiModalFlowInfo'
minItems: 1
qosInfo:
$ref: '#/components/schemas/QosInfo'
valServerBdw:
$ref: '#/components/schemas/ValServBdw'
valUsersBdw:
$ref: '#/components/schemas/ValUsersBdw'
protocolDesc:
$ref: '#/components/schemas/ProtocolDesc'
connStatusSubsc:
$ref: '#/components/schemas/SatConnStatusSubsc'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- valServerConnInfo
allOf:
- oneOf:
- required: [valServerConnInfo]
- required: [multiModalFlows]
- not:
required: [multiModalFlows, qosInfo]
TransResp:
description: >
......@@ -523,6 +530,8 @@ components:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTimeRo'
non3gppMeasInfo:
$ref: 'TS29548_SDD_PolicyConfiguration.yaml#/components/schemas/Non3gppAccessMeasPol'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
......@@ -609,7 +618,8 @@ components:
ProtocolDesc:
description: >
Represents the protocol description information for XR application data transmission.
Represents the protocol description information for Multi-modal application data
transmission.
type: object
properties:
dlDescInfo:
......@@ -665,6 +675,20 @@ components:
- valServerConnInfo
- notifUri
MultiModalFlowInfo:
description: >
Represents the multi-modal flow related application data transmission information.
type: object
properties:
valServerConnInfo:
$ref: '#/components/schemas/ConnInfo'
qosInfo:
$ref: '#/components/schemas/QosInfo'
protocolDesc:
$ref: '#/components/schemas/ProtocolDesc'
required:
- valServerConnInfo
# SIMPLE DATA TYPES
#
......@@ -705,7 +729,7 @@ components:
enum:
- regular
- urllc
- xr
- mm
- satellite
- type: string
description: >
......@@ -716,7 +740,7 @@ components:
Possible values are:
- regular: Indicates that the requested transmission type is Regular transmission.
- urllc: Indicates that the requested transmission type is URLLC transmission.
- xr: Indicates that the requested transmission type is XR transmission.
- mm: Indicates that the requested transmission type is Multi-modal transmission.
- satellite: Indicates that the requested transmission type is S&F Satellite transmission.
ClientConnStatus:
......
TS29549_SS_AADRF_DataManagement.yaml
View file @ 1a359940
......@@ -4,13 +4,13 @@ info:
title: SS_AADRF_DataManagement
description: |
API for A-ADRF Data Management Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.0.1"
version: "1.1.0-alpha.1"
externalDocs:
description: >
3GPP TS 29.549 V18.7.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -157,6 +157,51 @@ paths:
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/store:
post:
summary: Enables a service consumer to request data storage.
operationId: StoreData
tags:
- Data Storage Service
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataStoreReq'
required: true
responses:
'200':
description: >
Successful case. The data storage request is successfully received and processed.
content:
application/json:
schema:
$ref: '#/components/schemas/DataStoreResp'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
......@@ -228,6 +273,10 @@ components:
$ref: '#/components/schemas/EdgeReq'
apiLogReq:
$ref: '#/components/schemas/ApiLogReq'
s2sAnaReq:
$ref: '#/components/schemas/S2SAnalyticsReq'
ueRatAnaReq:
$ref: '#/components/schemas/UERatAnalyticsReq'
required:
- event
......@@ -276,7 +325,6 @@ components:
description: Version of the API which was invoked.
inputParameters:
type: string
description: List of input parameters.
result:
type: string
......@@ -291,6 +339,37 @@ components:
required:
- apiRequestorInfo
S2SAnalyticsReq:
description: >
Represents the Server to Server analytics data request requirement.
type: object
properties:
serverInfoList:
type: array
items:
$ref: 'TS29549_SS_ADAE_ServerToServerPerformanceAnalytics.yaml#/components/schemas/ServerInfo'
minItems: 1
timeVal:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
required:
- serverInfoList
UERatAnalyticsReq:
description: Represents the UE RAT connectivity analytics requirements.
type: object
properties:
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
timeVal:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
valUeAddrInfo:
type: array
items:
$ref: 'TS29549_SS_NetworkResourceAdaptation.yaml#/components/schemas/ValUeAddrInfo'
minItems: 1
required:
- valUeAddrInfo
DataManageNotification:
description: Represents the notification to the consumer.
type: object
......@@ -332,6 +411,10 @@ components:
description: Identification(s) of network slice(s) to which the subscription applies.
edgeInfo:
$ref: '#/components/schemas/EdgeInfo'
s2SAnaResp:
$ref: '#/components/schemas/S2SAnalyticsInfo'
ueRatAnaInfo:
$ref: '#/components/schemas/UERatAnalyticsInfo'
required:
- event
......@@ -374,6 +457,147 @@ components:
output:
type: string
S2SAnalyticsInfo:
description: >
Represents the Server to Server analytics data information.
type: object
properties:
dataOutput:
$ref: 'TS29549_SS_ADAE_ServerToServerPerformanceAnalytics.yaml#/components/schemas/S2SPerfAnalyticsData'
serverInfoList:
type: array
items:
$ref: 'TS29549_SS_ADAE_ServerToServerPerformanceAnalytics.yaml#/components/schemas/ServerInfo'
minItems: 1
required:
- dataOutput
- serverInfoList
UERatAnalyticsInfo:
description: Represents the UE RAT Connectivity Analytics data information.
type: object
properties:
analyticsOut:
type: array
items:
$ref: 'TS29549_SS_ADAE_UeRatConnectivityAnalytics.yaml#/components/schemas/UeRatAnalyticsOutput'
minItems: 1
required:
- analyticsOut
DataStoreReq:
description: Represents the data storage request.
type: object
properties:
subDataStore:
$ref: '#/components/schemas/DataStoreSub'
dirStorage:
$ref: '#/components/schemas/Data'
storeHandl:
$ref: '#/components/schemas/StorageHandlingInfo'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
oneOf:
- required: [subDataStore]
- required: [dirStorage]
DataStoreSub:
description: Represents the requirements for subscription based data storage.
type: object
properties:
dataProdId:
type: string
analyticsId:
type: string
analyticsType:
$ref: 'TS29549_SS_ADAE_VALPerformanceAnalytics.yaml#/components/schemas/AnalyticsType'
analyticsMode:
$ref: '#/components/schemas/AnalyticsMode'
profiles:
type: array
items:
$ref: '#/components/schemas/DataProducerProfile'
minItems: 1
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
duration:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
Data:
description: Represent the data for storage at A-ADRF.
type: object
properties:
dataType:
$ref: '#/components/schemas/DataType'
content:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
timestamp:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
analyticsId:
type: string
analyticsType:
$ref: 'TS29549_SS_ADAE_VALPerformanceAnalytics.yaml#/components/schemas/AnalyticsType'
dataSource:
$ref: '#/components/schemas/DataSourceInfo'
required:
- dataType
- content
- timestamp
- analyticsId
- analyticsType
- dataSource
DataProducerProfile:
description: Represents the data producer profile.
type: object
properties:
profile:
type: string
oneOf:
- required: [profile]
DataSourceInfo:
description: Represents the data source information.
type: object
properties:
source:
type: string
oneOf:
- required: [source]
StorageHandlingInfo:
description: Represent the storage handing information.
type: object
properties:
lifetime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
delNotifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
anyOf:
- required: [lifetime]
- required: [delNotifUri]
DataStoreResp:
description: Represents the data storage response.
type: object
properties:
storeHandl:
$ref: '#/components/schemas/StorageHandlingInfo'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- storeHandl
AnalyticsMode:
description: Represents the analytics mode.
type: object
properties:
mode:
$ref: '#/components/schemas/Mode'
isMlEnab:
type: boolean
required:
- mode
# Simple data types and Enumerations
AadrfEvent:
......@@ -384,6 +608,8 @@ components:
- NETWORK_SLICE
- EDGE_DATA
- LOCATION_ACCURACY
- SERVER_TO_SERVER_ANALYTICS
- UE_RAT_ANALYTICS
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration and
......@@ -395,6 +621,8 @@ components:
- NETWORK_SLICE: The event for the network slice data.
- EDGE_DATA: The event for the EDGE related data.
- LOCATION_ACCURACY: The event for the location accuracy data.
- SERVER_TO_SERVER_ANALYTICS: The event for the Server to Server analytics data.
- UE_RAT_ANALYTICS: The event for the UE RAT Connectivity analytics data.
ExposureLevel:
anyOf:
......@@ -413,3 +641,30 @@ components:
- READ: The exposure level for the logs to be exposed is read.
- WRITE: The exposure level for the logs to be exposed is write.
- DELETE: The exposure level for the logs to be exposed is delete.
DataType:
anyOf:
- type: string
enum:
- DATA
- ANALYTICS
- DELETE
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration and
is not used to encode content defined in the present version of this API.
description: |
Represents the type of data.
Mode:
anyOf:
- type: string
enum:
- ONLINE
- OFFLINE
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration and
is not used to encode content defined in the present version of this API.
description: |
Represents the supported modes of analytics.
TS29549_SS_ADAE_AIMLMemberCapabilityAnalytics.yaml
View file @ 1a359940
......@@ -6,11 +6,11 @@ info:
API for ADAE AIML member capability analytics analytics service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.0.0-alpha.1"
version: "1.0.0-alpha.2"
externalDocs:
description: >
3GPP TS 29.549 v19.2.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 v19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -26,15 +26,14 @@ servers:
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549
paths:
/application-aimlmca:
/application-aimlmcas:
post:
description: Creates a new individual AIML member capability analytics event subscription.
operationId: CreateIndAimlmcaEventSubsc
summary: Request the creation of AIML Member Capability Analytics Subscription.
operationId: CreateIndAimlmcaSubsc
tags:
- AIML member capability analytics event subscriptions (Collection)
- AIML Member Capability Analytics Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
......@@ -80,7 +79,9 @@ paths:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
responses:
'201':
description: AIML member capability analytics event subscription resource created successfully.
description: The AIML Member Capability Analytics Subscription is successfully
created and a representation of the created Individual AIML Member Capability Analytics
Subscription resource shall be returned.
content:
application/json:
schema:
......@@ -114,23 +115,26 @@ paths:
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/application-aimlmca/{appAimlmcaId}:
get:
description: Retrieves an individual AIML member capability analytics event subscription.
operationId: ReadIndAimlmcaEventSubsc
tags:
- Individual AIML member capability analytics event subscription (Document)
/application-aimlmcas/{appAimlmcaId}:
parameters:
- name: appAimlmcaId
in: path
description: Identifier of an individual AIML member capability analytics event subscription.
description: >
Represents the identifier of an Individual AIML Member Capability Analytics Subscription
resource.
required: true
schema:
type: string
get:
summary: Retrieves an existing Individual AIML Member Capability Analytics Subscription.
operationId: ReadIndAimlmcaSubsc
tags:
- Individual AIML Member Capability Analytics Subscription (Document)
responses:
'200':
description: >
The individual AIML member capability analytics subscription matching the appAimlmcaId is retrieved.
The requested Individual AIML Member Capability Analytics subscription matching the appAimlmcaId shall be returned.
content:
application/json:
schema:
......@@ -157,22 +161,127 @@ paths:
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Request the update of an existing Individual AIML Member Capability Analytics Subscription resource.
operationId: UpdateIndAimlmcaSubsc
tags:
- Individual AIML Member Capability Analytics Subscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AppAimlMemCapSub'
responses:
'200':
description: >
OK. The Individual AIML Member Capability Analytics Subscription resource is
successfully updated and a representation of the updated resource shall be returned in
the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/AppAimlMemCapSub'
'204':
description: >
No Content. The Individual AIML Member Capability Analytics Subscription resource
is successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Request the modification of an existing Individual AIML Member Capability Analytics Subscription resource.
operationId: ModifyIndAimlmcaSubsc
tags:
- Individual AIML Member Capability Analytics Subscription (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/AppAimlMemCapSubPatch'
responses:
'200':
description: >
OK. The Individual AIML Member Capability Analytics Subscription resource is
successfully modified and a representation of the updated resource shall be returned in
the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/AppAimlMemCapSub'
'204':
description: >
No Content. The Individual AIML Member Capability Analytics Subscription resource
is successfully modified and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
description: Deletes an individual AIML member capability analytics event subscription.
operationId: DeleteIndAimlmcaEventSubsc
summary: Request the deletion of an existing Individual AIML Member Capability Analytics Subscription resource.
operationId: DeleteIndAimlmcaSubsc
tags:
- Individual AIML member capability analytics event subscription (Document)
- Individual AIML Member Capability Analytics Subscription (Document)
parameters:
- name: appAimlmcaId
in: path
description: Identifier of an individual AIML member capability analytics event subscription.
description: Identifier of an Individual AIML member Capability Analytics Subscription.
required: true
schema:
type: string
responses:
'204':
description: >
The individual AIML member capability analytics subscription matching the appAimlmcaId is deleted.
The Individual AIML Member Capability Analytics Subscription matching the appAimlmcaId is deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
......@@ -214,26 +323,12 @@ components:
$ref: '#/components/schemas/AppAimlMemCapAnalytics'
analyticsType:
$ref: 'TS29549_SS_ADAE_VALPerformanceAnalytics.yaml#/components/schemas/AnalyticsType'
ueIds:
type: array
items:
type: string
minItems: 1
description: >
One or more VAL UE IDs whose analytics or data collection are subject to subcription.
aimlMemberIds:
type: array
items:
$ref: '#/components/schemas/AimlMemberId'
minItems: 1
description: >
One or more AIML members whose analytics or data collection are subject to subcription.
analyticsSub:
$ref: '#/components/schemas/AppAimlMemCapAnalyticsSub'
confLevel:
type: integer
minimum: 0
maximum: 100
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
repReq:
......@@ -242,36 +337,121 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- notifUri
- analyticsId
- analyticsType
- analyticsSub
AppAimlMemCapNotif:
description: Represents notification of the AIML member capability analytics event.
type: object
properties:
analyticsOutput:
type: string
analyticsId:
$ref: '#/components/schemas/AppAimlMemCapAnalytics'
$ref: '#/components/schemas/AppAimlMemCapAnalyticsOutput'
confLevel:
type: integer
minimum: 0
maximum: 100
required:
- analyticsOutput
AppAimlMemCapSubPatch:
description: Represents the requested modification to a Individual AIML member capability analytics subscription resource.
type: object
properties:
analyticsSub:
$ref: '#/components/schemas/AppAimlMemCapAnalyticsSub'
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
confLevel:
type: integer
minimum: 0
maximum: 100
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
repReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
AppAimlMemCapAnalyticsSub:
description: Represents the information related to the analytics subscription.
type: object
properties:
ueIds:
type: array
items:
type: string
minItems: 1
description: List of VAL UEs identifiers.
description: >
One or more VAL UE IDs whose analytics or data collection are subject to subcription.
aimlMemberIds:
type: array
items:
$ref: '#/components/schemas/AimlMemberId'
minItems: 1
description: List of AIML members identifiers.
confLevel:
type: integer
minimum: 0
maximum: 100
description: >
One or more AIML members whose analytics or data collection are subject to subcription.
aimlMemCapAttribute:
$ref: '#/components/schemas/AppAimlMemCapAttributes'
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
oneOf:
- required: [ueIds]
- required: [aimlMemberIds]
AppAimlMemCapAnalyticsOutput:
description: Represents analytics output information in the notification.
type: object
properties:
analyticsId:
$ref: '#/components/schemas/AppAimlMemCapAnalytics'
analyticsOutput:
type: array
items:
$ref: '#/components/schemas/AnalyticsOutput'
minItems: 1
description: >
Contains a list of identities of one or more VAL UEs or AIML members, the data
collection related to, in the case of the notification is on the AIML member capability
data collection.
required:
- analyticsOutput
- analyticsId
AnalyticsOutput:
description: Represents analytics output information in the notification.
type: object
properties:
ueId:
type: string
aimlMemberId:
items:
$ref: '#/components/schemas/AimlMemberId'
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
aimlMemAvails:
type: array
items:
$ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime'
minItems: 1
aimlMemCaps:
$ref: '#/components/schemas/AimlMemCapability'
required:
- aimlMemAvails
oneOf:
- required: [ueId]
- required: [aimlMemberId]
AimlMemCapability:
description: Represents AIML member capability information in the notification.
type: object
properties:
maxAimlMemConn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
minAimlMemConn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
# SIMPLE DATA TYPES
#
......@@ -297,3 +477,18 @@ components:
Represents Connection Status Events.
Possible values are:
- APP_MEMBER_CAPABILITY: Indicates that the identifier of the analytics consumer.
AppAimlMemCapAttributes:
anyOf:
- type: string
enum:
- COMMUNICATION_CAPABILITY
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
and is not used to encode content defined in the present version of this API.
description: |
Represents Connection Status Events.
Possible values are:
- COMMUNICATION_CAPABILITY: Indicates that the requested attribute to be analyzed is
communication capability.
TS29549_SS_ADAE_EdgeLoadAnalytics.yaml
View file @ 1a359940
......@@ -4,13 +4,13 @@ info:
title: SS_ADAE_EdgeLoadAnalytics
description: |
API for ADAE Edge Load Analytics.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.0.0"
version: "1.1.0-alpha.1"
externalDocs:
description: >
3GPP TS 29.549 V18.6.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -206,6 +206,8 @@ components:
description: Represents an individual Edge Load Subscription resource.
type: object
properties:
analyticsId:
$ref: '#/components/schemas/AnalyticsIdEl'
analyticsType:
$ref: 'TS29549_SS_ADAE_VALPerformanceAnalytics.yaml#/components/schemas/AnalyticsType'
destinationEasInfo:
......@@ -248,10 +250,113 @@ components:
description: Represents notification information of an Edge Load Event.
type: object
properties:
output:
$ref: '#/components/schemas/AnalyticsOutputEl'
analyticsOutput:
type: string
description: String representing the edge load analytics.
confLevel:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
oneOf:
- required: [output]
- required: [analyticsOutput]
AnalyticsOutputEl:
description: Represents the edge load analytics output.
type: object
properties:
analyticsId:
$ref: '#/components/schemas/AnalyticsIdEl'
platAnalytics:
$ref: '#/components/schemas/EdgePlatformAnalytics'
eesAnalytics:
$ref: '#/components/schemas/EesAnalytics'
easAnalytics:
$ref: '#/components/schemas/EasAnalytics'
required:
- analyticsOutput
- analyticsId
EdgePlatformAnalytics:
description: Represents the edge platform analytics data.
type: object
properties:
easConn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
eesConn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
confLevel:
type: integer
minimum: 0
maximum: 100
timeWnd:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
anyOf:
- required: [easConn]
- required: [eesConn]
EesAnalytics:
description: Represents the EES analytics data.
type: object
properties:
eesUnavail:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime'
minItems: 1
eesUnavailPer:
type: integer
minimum: 0
maximum: 100
confLevel:
type: integer
minimum: 0
maximum: 100
timeWnd:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
anyOf:
- required: [eesUnavail]
- required: [eesUnavailPer]
EasAnalytics:
description: Represents the EAS analytics data.
type: object
properties:
easUnavail:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime'
minItems: 1
easUnavailPer:
type: integer
minimum: 0
maximum: 100
confLevel:
type: integer
minimum: 0
maximum: 100
timeWnd:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
anyOf:
- required: [easUnavail]
- required: [easUnavailPer]
# Simple data types and Enumerations
AnalyticsIdEl:
anyOf:
- type: string
enum:
- EDGE_PLATFORM
- EES
- EAS
- 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.
description: |
Represents the analytics identifier for the edge load analytics.
Possible values are:
- EDGE_PLATFORM: Indicates that the analytics identifier is edge platform analytics.
- EES: Indicates that the analytics identifier is EES analytics.
- EAS: Indicates that the analytics identifier is EAS analytics.
TS29549_SS_ADAE_LocationAccuracyAnalytics.yaml
View file @ 1a359940
......@@ -4,13 +4,13 @@ info:
title: SS_ADAE_LocationAccuracyAnalytics
description: |
API for ADAE location accuracy performance analytics service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.0.0"
version: "1.1.0-alpha.1"
externalDocs:
description: >
3GPP TS 29.549 V18.6.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -214,6 +214,8 @@ components:
properties:
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
analyticsId:
$ref: '#/components/schemas/LocAccurAnalytics'
analyticsType:
$ref: 'TS29549_SS_ADAE_VALPerformanceAnalytics.yaml#/components/schemas/AnalyticsType'
valUeIds:
......@@ -255,10 +257,113 @@ components:
description: Represents notification of the location accuracy performance event.
type: object
properties:
analyticsOutput:
$ref: '#/components/schemas/LocAccurAnalyticsOutput'
output:
type: string
description: Event output data.
confLevel:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
oneOf:
- required: [analyticsOutput]
- required: [output]
LocAccurAnalyticsOutput:
description: >
Represents the location accuracy analytics output.
type: object
properties:
analyticsId:
$ref: '#/components/schemas/LocAccurAnalytics'
valUeIds:
type: array
items:
type: string
minItems: 1
valServId:
type: string
predictions:
type: array
items:
$ref: '#/components/schemas/LocAccurPrediction'
minItems: 1
sustainAnalytics:
$ref: '#/components/schemas/LocAccurSustain'
required:
- output
- analyticsId
LocAccurPrediction:
description: >
Represents the location accuracy prediction analytics output.
type: object
properties:
accurChange:
$ref: '#/components/schemas/LocAccurChange'
areas:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
minItems: 1
timeWnd:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
confLevel:
type: integer
minimum: 0
maximum: 100
required:
- accurChange
LocAccurSustain:
description: >
Represents the location accuracy sustainability analytics output.
type: object
properties:
areas:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
minItems: 1
timeWnd:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
confLevel:
type: integer
minimum: 0
maximum: 100
# Simple data types and Enumerations
LocAccurAnalytics:
anyOf:
- type: string
enum:
- LOCATION_ACCURACY_PREDICTION
- LOCATION_ACCURACY_SUSTAINABILITY
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration and is not used to encode
content defined in the present version of this API.
description: |
Represents the analytics identifier for location accuracy analytics.
Possible values are:
- LOCATION_ACCURACY_PREDICTION: Indicates that the requested analytics is location
accuracy prediction.
- LOCATION_ACCURACY_SUSTAINABILITY: Indicates that the requested analytics is
location accuracy sustainability.
LocAccurChange:
anyOf:
- type: string
enum:
- DOWNGRADE
- UPGRADE
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration and is not used to encode
content defined in the present version of this API.
description: |
Rerpresents the type of location accuracy change.
Possible values are:
- DOWNGRADE: Indicates the downgrade of the location accuracy.
- UPGRADE: Indicates the upgrade of the location accuracy.
TS29549_SS_ADAE_ServerToServerPerformanceAnalytics.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: SS_ADAE_ServerToServerPerformanceAnalytics
version: 1.0.0-alpha.1
description: |
API for ADAE Server to Server Performance Analytics service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/ss-adae-sspa/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549
paths:
/subscriptions:
post:
summary: Create an "Individual Server to Server Performance Analytics Subscription" resource.
operationId: SubscribeServer2ServerPerformanceAnalytics
tags:
- Server to Server Performance Analytics Subscription (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/S2SPerfSubsc'
responses:
'201':
description: >
Subscription to the Server to Server Performance analytics is created.
content:
application/json:
schema:
$ref: '#/components/schemas/S2SPerfSubsc'
headers:
Location:
description: Contains the URI of the newly created individual resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
NotifyServerToServerPerformance:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/S2SPerfNotif'
responses:
'204':
description: The notification is successfully received.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
parameters:
- name: subscriptionId
in: path
description: >
Represents the identifier of an Individual Server to Server Performance Analytics
Subscription.
required: true
schema:
type: string
get:
summary: Read the "Individual Server to Server Performance Analytics Subscription" resource.
operationId: ReadIndServer2ServerPerformanceSubscription
tags:
- Individual Server to Server Performance Analytics Subscription (Document)
responses:
'200':
description: >
The requested "Individual Server to Server Performance Analytics Subscription"
resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/S2SPerfSubsc'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
description: >
Update the "Individual Server to Server Performance Analytics Subscription" resource.
operationId: UpdateIndServer2ServerPerformanceSubscription
tags:
- Individual Server to Server Performance Analytics Subscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/S2SPerfSubsc'
responses:
'200':
description: >
OK. The Individual Server to Server Performance Analytics Subscription resource
is successfully updated, and representation of updated resource is returned in
the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/S2SPerfSubsc'
'204':
description: >
No Content. The Individual Server to Server Performance Analytics Subscription resource
is successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
description: >
Modify the "Individual Server to Server Performance Analytics Subscription" resource.
operationId: ModifyIndServer2ServerPerformanceSubscription
tags:
- Individual Server to Server Performance Analytics Subscription (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/S2SPerfSubscPatch'
responses:
'200':
description: >
OK. The Individual Server to Server Performance Analytics Subscription resource is
successfully modified, and representation of the modified resource is returned
in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/S2SPerfSubsc'
'204':
description: >
No Content. The Individual Server to Server Performance Analytics Subscription resource
is successfully modified and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Delete the "Individual Server to Server Performance Analytics Subscription" resource.
operationId: DeleteIndServer2ServerPerformanceSubscription
tags:
- Individual Server to Server Performance Analytics Subscription (Document)
responses:
'204':
description: >
The "Individual Server to Server Performance Analytics Subscription" resource
matching the subscriptionId is deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
S2SPerfSubsc:
description: >
Represents the Server to Server Performance analytics subscription.
type: object
properties:
analyticsIds:
type: array
items:
$ref: '#/components/schemas/AnalyticsIdSspa'
minItems: 1
analyticsType:
$ref: 'TS29549_SS_ADAE_VALPerformanceAnalytics.yaml#/components/schemas/AnalyticsType'
serverInfoList:
type: array
items:
$ref: '#/components/schemas/ServerInfo'
minItems: 1
valServId:
type: string
repReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
confLevel:
type: integer
minimum: 0
maximum: 100
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
serverIdList:
type: array
items:
type: string
minItems: 1
serverIpAddList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
minItems: 1
timeVal:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- analyticsType
- notifUri
- serverInfoList
S2SPerfSubscPatch:
description: >
Represents the Server to Server Performance analytics subscription modification request.
type: object
properties:
serverInfoList:
type: array
items:
$ref: '#/components/schemas/ServerInfo'
minItems: 1
valServId:
type: string
repReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
confLevel:
type: integer
minimum: 0
maximum: 100
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
timeVal:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
S2SPerfNotif:
description: >
Represents the Server to Server Performance analytics notification.
type: object
properties:
analyticsIds:
type: array
items:
$ref: '#/components/schemas/AnalyticsIdSspa'
minItems: 1
analyticsOutput:
type: array
items:
$ref: '#/components/schemas/S2SPerfAnalyticsData'
minItems: 1
confLevel:
type: integer
minimum: 0
maximum: 100
required:
- analyticsOutput
S2SPerfAnalyticsData:
description: >
Represent the Server to Server Performance analytics data.
type: object
properties:
performChgInd:
type: boolean
description: >
Indicates whether a server-to-server session performance has changed.When present, it
shall be set as follows:
- true: the performance has changed.
- false: the performance is not changed.
- Default value when omitted is "false".
timHorizOverInd:
type: boolean
description: >
Indicates whether a server-to-server session performance sustainability has over a given
time horizon.When present, it shall be set as follows:
- true: the performance sustainability has over the given time horizon.
- false: the performance sustainability has not over the given time horizon.
- Default value when omitted is "false".
areaOverInd:
type: boolean
description: >
Indicates whether a server-to-server session performance sustainability has over a given
area.When present, it shall be set as follows:
- true: the performance sustainability has over the given area.
- false: the performance sustainability has not over the given area.
- Default value when omitted is "false".
qosMeasureRslt:
description: >
Represents the QoS measurement result for the Server to Server Performance between any
VAL UEs within the given area.
$ref: 'TS29549_SS_Ue2UePerformanceAnalytics.yaml#/components/schemas/U2UAnalyticsData'
anyOf:
- required: [performChgInd]
- required: [timHorizOverInd]
- required: [areaOverInd]
- required: [qosMeasureRslt]
ServerInfo:
description: >
Represents the Server Information.
type: object
properties:
serverId:
type: string
serverIpAddList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
minItems: 1
anyOf:
- required: [serverId]
- required: [serverIpAddList]
# Simple data types and Enumerations
AnalyticsIdSspa:
anyOf:
- type: string
enum:
- SERVER_TO_SERVER_PERFORMANCE
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration and is not used to encode
content defined in the present version of this API.
description: |
Represents the analytic IDs for Server to Server Performance Analytics.
Possible values are:
- SERVER_TO_SERVER_PERFORMANCE: Indicates that the requested analytics is Server to Server
Performance analytics.
TS29549_SS_ADAE_SlicePerformanceAnalytics.yaml
View file @ 1a359940
......@@ -4,13 +4,13 @@ info:
title: SS_ADAE_SlicePerformanceAnalytics
description: |
API for ADAE slice-specific application performance analytics service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.0.0"
version: "1.1.0-alpha.1"
externalDocs:
description: >
3GPP TS 29.549 V18.6.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -233,6 +233,8 @@ components:
type: string
description: >
Identity of the VAL server if the consumer is different than the VAL server of interest.
valServiceId:
type: string
confLevel:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
area:
......@@ -254,6 +256,11 @@ components:
description: Represents notification of the slice-specific application performance event.
type: object
properties:
analyticsOutput:
type: array
items:
$ref: '#/components/schemas/SliceAppPerfAnalytics'
minItems: 1
output:
type: string
description: Output data.
......@@ -261,5 +268,44 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
timeHorizon:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
required:
- output
oneOf:
- required: [output]
- required: [analyticsOutput]
SliceAppPerfAnalytics:
description: >
Represents the analytics output for slice performance analytics.
type: object
properties:
valServerId:
type: string
valServiceId:
type: string
sliceId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
minRtt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
avgRtt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
maxRtt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
minLat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
avgLat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
maxLat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
allOf:
- anyOf:
- required: [valServerId]
- required: [valServiceId]
- required: [sliceId]
- anyOf:
- required: [minRtt]
- required: [avgRtt]
- required: [maxRtt]
- required: [minLat]
- required: [avgLat]
- required: [maxLat]
TS29549_SS_ADAE_UeRatConnectivityAnalytics.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: SS_ADAE_UeRatConnectivityAnalytics
version: 1.0.0-alpha.1
description: |
API for ADAE UE RAT Connectivity Analytics service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/ss-adae-uerat/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549
paths:
/subscriptions:
post:
summary: Create a new UE RAT Connectivity Analytics Subscription.
operationId: CreateUeRatConnAnalyticsSubsc
tags:
- UE RAT Connectivity Analytics Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UeRatConnectivitySub'
responses:
'201':
description: >
Created. The UE RAT Connectivity Analytics Subscription is successfully created and a
representation of the created Individual UE RAT Connectivity Analytics Subscription
resource shall be returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/UeRatConnectivitySub'
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
UeRatConnAnalyticsNotif:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UeRatConnectivityNotif'
responses:
'204':
description: >
No Content. The UE RAT Connectivity Analytics Notification is successfully
received and acknowledged.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
parameters:
- name: subscriptionId
in: path
description: >
Represents the identifier of the UE RAT Connectivity Analytics Subscription.
required: true
schema:
type: string
get:
summary: Retrieve an existing Individual UE RAT Connectivity Analytics Subscription resource.
operationId: GetIndUeRatConnAnalyticsSubsc
tags:
- Individual UE RAT Connectivity Analytics Subscription (Document)
responses:
'200':
description: >
OK. The requested Individual UE RAT Connectivity Analytics Subscription
resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/UeRatConnectivitySub'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Request the update of an existing Individual UE RAT Connectivity Analytics Subscription resource.
operationId: UpdateIndUeRatConnAnalyticsSubsc
tags:
- Individual UE RAT Connectivity Analytics Subscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UeRatConnectivitySub'
responses:
'200':
description: >
OK. The Individual UE RAT Connectivity Analytics Subscription resource is successfully
updated and a representation of the updated resource shall be returned in the response
body.
content:
application/json:
schema:
$ref: '#/components/schemas/UeRatConnectivitySub'
'204':
description: >
No Content. The Individual UE RAT Connectivity Analytics Subscription resource is
successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Request the modification of an existing Individual UE RAT Connectivity Analytics Subscription resource.
operationId: ModifyIndUeRatConnAnalyticsSubsc
tags:
- Individual UE RAT Connectivity Analytics Subscription (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/UeRatConnectivitySubPatch'
responses:
'200':
description: >
OK. The Individual UE RAT Connectivity Analytics Subscription resource is successfully
modified and a representation of the updated resource shall be returned in the response
body.
content:
application/json:
schema:
$ref: '#/components/schemas/UeRatConnectivitySub'
'204':
description: >
No Content. The Individual UE RAT Connectivity Analytics Subscription resource is
successfully modified and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Request the deletion of an existing Individual UE RAT Connectivity Analytics Subscription resource.
operationId: RemoveUeRatConnectivityAnalytics
tags:
- Individual UE RAT Connectivity Analytics Subscription (Document)
responses:
'204':
description: >
The Individual UE RAT Connectivity Analytics Subscription resource
is successfully deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
# Structured Data Types
UeRatConnectivitySub:
description: >
Represents the UE RAT Connectivity Analytics subscription.
type: object
properties:
analyticsSubs:
type: array
items:
$ref: '#/components/schemas/UeRatAnalyticsSub'
minItems: 1
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
report:
$ref: '#/components/schemas/UeRatConnectivityNotif'
repReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
timeInterval:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- analyticsSubs
- notifUri
UeRatConnectivitySubPatch:
description: >
Represents the requested modifications to a UE RAT Connectivity Analytics subscription.
type: object
properties:
analyticsSubs:
type: array
items:
$ref: '#/components/schemas/UeRatAnalyticsSub'
minItems: 1
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
reportReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
timeInterval:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
UeRatConnectivityNotif:
description: >
Represents the UE RAT Connectivity AnalyticsUE RAT connectivity analytics
Notification.
type: object
properties:
subId:
type: string
analyticsOut:
type: array
items:
$ref: '#/components/schemas/UeRatAnalyticsOutput'
minItems: 1
required:
- subId
- analyticsOut
UeRatAnalyticsOutput:
description: >
Represents the UE RAT Connectivity Analytics output information.
type: object
properties:
analyticsIds:
type: array
items:
$ref: '#/components/schemas/AnalyticsIdUeRat'
minItems: 1
areaApp:
$ref: '#/components/schemas/AreaPrediction'
timeApp:
$ref: '#/components/schemas/TimeWindowPrediction'
valUeIds:
type: array
items:
type: string
minItems: 1
valSvcId:
type: string
required:
- analyticsIds
- valUeIds
UeRatAnalyticsSub:
description: >
Represents the UE RAT Connectivity Analytics Subscription related information.
type: object
properties:
analyticsIds:
type: array
items:
$ref: '#/components/schemas/AnalyticsIdUeRat'
minItems: 1
valUeIds:
type: array
items:
type: string
minItems: 1
valGroupId:
type: string
ueMobs:
type: object
additionalProperties:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeMobility'
minProperties: 1
description: >
Contains the mobility and route information of the target VAL UEs.
The key of the map shall be set to the value of the identifier of the VAL UE
(among the ones provided within the valUeIds attribute or the members of the VAL group
identified by the valGroupId attribute) to which the mobility and route information
provided within the map value is related.
valSvcId:
type: string
description: Identity of the VAL service
confLevel:
type: integer
minimum: 0
maximum: 100
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
required:
- analyticsIds
oneOf:
- required: [valUeIds]
- required: [valGroupId]
AreaPrediction:
description: >
Represents the RAT type changes for a given way point.
type: object
properties:
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
timePer:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
confLevel:
type: integer
minimum: 0
maximum: 100
required:
- area
- timePer
TimeWindowPrediction:
description: >
Represents the time periods for predictions.
type: object
properties:
timePer:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
confLevel:
type: integer
minimum: 0
maximum: 100
required:
- timePer
# Simple data types and Enumerations
AnalyticsIdUeRat:
anyOf:
- type: string
enum:
- UE_RAT_CONNECTIVITY_ANALYTICS
- type: string
description: >
Indicates that the requested analytics is UE RAT connectivity analytics event.
description: |
Represents the UE RAT connectivity analytics identifier.
- UE_RAT_CONNECTIVITY_ANALYTICS: Indicates that the requested analytics is UE RAT
Connectivity Analytics.
TS29549_SS_ADAE_VALPerformanceAnalytics.yaml
View file @ 1a359940
......@@ -4,13 +4,13 @@ info:
title: SS_ADAE_VALPerformanceAnalytics
description: |
API for ADAE VAL performance analytics service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.1.0-alpha.1"
version: "1.1.0-alpha.2"
externalDocs:
description: >
3GPP TS 29.549 V19.0.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -211,6 +211,8 @@ components:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
analyticsType:
$ref: '#/components/schemas/AnalyticsType'
analyticsId:
$ref: '#/components/schemas/AnalyticsIdVpa'
valServiceId:
type: string
valUeIds:
......@@ -225,14 +227,23 @@ components:
description: Identity of the VAL server
dataProdProfile:
$ref: '#/components/schemas/ProdProfileInfo'
clientAppData:
$ref: '#/components/schemas/ClientApplicationData'
confLevel:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
repThrs:
type: array
items:
$ref: '#/components/schemas/PerfThreshold'
minItems: 1
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
repReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
expReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
......@@ -244,6 +255,8 @@ components:
description: Represents notification of the VAL performance event.
type: object
properties:
analyticsOutput:
$ref: '#/components/schemas/AnalyticsOutput'
output:
type: string
description: Provided output for analytics.
......@@ -256,13 +269,17 @@ components:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
minItems: 1
description: List of VAL UE identifiers.
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
confLevel:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
timeHorizon:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
required:
- output
- valServerId
oneOf:
- required: [output]
- required: [analyticsOutput]
ProdProfileInfo:
description: Represents capability of the data producer.
......@@ -318,6 +335,91 @@ components:
required:
- category
PerfData:
description: Represents the performance data.
type: object
properties:
rtt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
avgDataRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
maxDataRate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
jitter:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
qoeMos:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
qoeStalEvent:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
qoeStalRatio:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
qosProfileLoad:
type: integer
minimum: -100
maximum: 100
valTrafLoad:
type: integer
minimum: -100
maximum: 100
valSesPerfChange:
type: integer
minimum: -100
maximum: 100
anyOf:
- required: [rtt]
- required: [avgDataRate]
- required: [maxDataRate]
- required: [jitter]
- required: [qoeMos]
- required: [qoeStalEvent]
- required: [qoeStalRatio]
- required: [qosProfileLoad]
- required: [valTrafLoad]
- required: [valSesPerfChange]
PerfThreshold:
description: >
Represents the performance threshold.
type: object
properties:
value:
$ref: '#/components/schemas/PerfData'
thrDirect:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MatchingDirection'
required:
- value
- thrDirect
ClientApplicationData:
description: >
Represents the ADAE client application data.
type: object
properties:
ueRoute:
$ref: 'TS29257_UAE_ChangeUSSManagement.yaml#/components/schemas/UasRoute'
sesSched:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime'
minItems: 1
anyOf:
- required: [ueRoute]
- required: [sesSched]
AnalyticsOutput:
description: >
Represents the VAL performance analytics output.
type: object
properties:
analyticsId:
$ref: '#/components/schemas/AnalyticsIdVpa'
valServ:
$ref: '#/components/schemas/PerfData'
valSess:
$ref: '#/components/schemas/PerfData'
required:
- analyticsId
# Simple data types and Enumerations
AnalyticsCategory:
......@@ -410,3 +512,20 @@ components:
- GENERATING_ENTITY: The role of the data producer is generating entity.
- ORIGINAL_PRODUCER: The role of the data producer is origina producer.
- RESPOSITORY: The role of the data producer is repository.
AnalyticsIdVpa:
anyOf:
- type: string
enum:
- VAL_SERVER_PERF
- VAL_SESSION_PERF
- 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.
description: |
Represents the analytics identifier for VAL performance analytics.
Possible values are:
- VAL_SERVER_PERF: Indicates that requested analytics is VAL server performance analytics.
- VAL_SESSION_PERF: Indicates that requested analytics is VAL session performance analytics.
TS29549_SS_ADCCF_DataCollection.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: SS_ADCCF_DataCollection API
version: 1.0.0-alpha.1
description: |
API for A-DCCF Data Collection service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
security:
- {}
- oAuth2ClientCredentials: []
servers:
- url: '{apiRoot}/ss-adccf-dc/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549
paths:
/subscriptions:
post:
summary: Create an "Individual Data Collection Subscription" resource.
operationId: SubscribeDataCollection
tags:
- Data Collection Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DataCollectionSub'
responses:
'201':
description: >
The "Individual Data Collection Subscription" resource is created.
content:
application/json:
schema:
$ref: '#/components/schemas/DataCollectionSub'
headers:
Location:
description: Contains the URI of the newly created individual resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
DataCollectionNotif:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DataCollectionNotif'
responses:
'204':
description: The notification is successfully received.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
parameters:
- name: subscriptionId
in: path
description: >
Represents the identifier of an Individual Location-Related UE
Group Analytics Subscription.
required: true
schema:
type: string
get:
summary: Read the "Individual Data Collection Subscription" resource.
operationId: ReadDataCollectionSubscription
tags:
- Individual Data Collection Subscription (Document)
responses:
'200':
description: >
The requested "Individual Data Collection Subscription"
resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/DataCollectionSub'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Remove the "Individual Data Collection Subscription" resource.
operationId: RemoveDataCollectionSubscription
tags:
- Individual Data Collection Subscription (Document)
responses:
'204':
description: >
The "Individual Data Collection Subscription" resource
matching the subscriptionId is deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
DataCollectionSub:
description: >
Represents the Data Collection Subscription.
type: object
properties:
dataColEvnId:
type: string
dataColReq:
$ref: '#/components/schemas/DataCollectionReq'
repReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
analyticsId:
type: string
dataProdIds:
type: array
items:
type: string
minItems: 1
profiles:
type: array
items:
$ref: 'TS29549_SS_AADRF_DataManagement.yaml#/components/schemas/DataProducerProfile'
minItems: 1
area:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
duration:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
procReq:
$ref: '#/components/schemas/ProcessingReq'
storageReqs:
$ref: '#/components/schemas/StorageRequirements'
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
report:
$ref: '#/components/schemas/DataCollectionNotif'
required:
- dataColEvnId
- dataColReq
- notifUri
DataCollectionNotif:
description: >
Represents the Data Collection Notification.
type: object
properties:
dataColEvnId:
type: string
analyticsId:
type: string
analyticsType:
$ref: 'TS29549_SS_ADAE_VALPerformanceAnalytics.yaml#/components/schemas/AnalyticsType'
dataType:
$ref: '#/components/schemas/AdccfDataType'
dataOutput:
type: string
procReq:
$ref: '#/components/schemas/ProcessingReq'
storageReqs:
type: array
items:
type: string
minItems: 1
required:
- dataColEvnId
- dataOutput
DataCollectionReq:
description: >
Represents the data collection requirements.
type: object
properties:
dataFormat:
$ref: 'TS29222_CAPIF_Publish_Service_API.yaml#/components/schemas/DataFormat'
repFreq:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
abstraction:
type: integer
minimum: 0
maximum: 100
accuracy:
type: integer
minimum: 0
maximum: 100
required:
- dataFormat
- repFreq
- abstraction
- accuracy
ProcessingReq:
description: >
Represents the data processing requirements.
type: object
properties:
req:
type: string
anyOf:
- required: [req]
AdccfDataType:
description: >
Represents A-DCCD data type.
type: object
properties:
type:
$ref: '#/components/schemas/DataType'
gran:
$ref: '#/components/schemas/GranularityType'
oneOf:
- required: [type]
- required: [gran]
DataOutput:
description: >
Represents the A-DCCF data output.
type: object
properties:
dataOutput:
type: string
required:
- dataOutput
StorageRequirements:
description: >
Represents the data storage requirements.
type: object
properties:
storageReqs:
type: array
items:
type: string
minItems: 1
required:
- storageReqs
# Simple data types and Enumerations
DataType:
anyOf:
- type: string
enum:
- UE_DATA
- NETWORK_DATA
- APP_DATA
- EDGE_DATA
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration and is not used to encode
content defined in the present version of this API.
description: |
Represents the data type.
Possible values are:
- UE_DATA: Indicates that the data sample related to the UE data.
- NETWORK_DATA: Indicates that the data sample related to the network data.
- APP_DATA: Indicates that the data sample related to the application data.
- EDGE_DATA: Indicates that the data sample related to the edge data.
GranularityType:
anyOf:
- type: string
enum:
- REAL_TIME
- NON_REAL_TIME
- type: string
description: >
This string provides forward-compatibility with future
extensions to the enumeration and is not used to encode
content defined in the present version of this API.
description: |
Represents the granularity type.
Possible values are:
- REAL_TIME: Indicates that the data granularity is real time.
- NON_REAL_TIME: Indicates that the data granularity is non-real time.
TS29549_SS_Events.yaml
View file @ 1a359940
......@@ -6,11 +6,11 @@ info:
API for SEAL Events management.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.3.0-alpha.3"
version: "1.3.0-alpha.4"
externalDocs:
description: >
3GPP TS 29.549 V19.2.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -387,6 +387,11 @@ components:
VA UEs moving in and out of the provided location area.
partialFailRep:
$ref: '#/components/schemas/PartialEventSubscFailRep'
satSfTrigger:
type: array
items:
$ref: '#/components/schemas/SatSfTrigger'
minItems: 1
required:
- eventId
......@@ -449,6 +454,11 @@ components:
type: string
minItems: 1
description: Contains the identifier(s) of the deleted VAL Group(s).
satSfInfo:
type: array
items:
$ref: '#/components/schemas/SatSfInfo'
minItems: 1
required:
- eventId
......@@ -638,6 +648,8 @@ components:
$ref: 'TS29549_SS_VALServiceAreaConfiguration.yaml#/components/schemas/ValSvcAreaId'
notInt:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
dynamicLoc:
$ref: '#/components/schemas/ReferenceUEDetail'
events:
type: array
items:
......@@ -651,6 +663,7 @@ components:
oneOf:
- required: [locInt]
- required: [valSvcId]
- required: [dynamicLoc]
LocationDevMonReport:
description: Location deviation monitoring report.
......@@ -857,6 +870,7 @@ components:
oneOf:
- required: [timeWindows]
- required: [timeSchedule]
GeofencingConditions:
description: Represents the geofencing conditions.
type: object
......@@ -875,6 +889,8 @@ components:
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime'
minItems: 1
refUECap:
$ref: '#/components/schemas/RefUeCap'
MovTimingInfo:
description: Represents the timing information of a VAL UE's movements.
......@@ -888,6 +904,34 @@ components:
- required: [timestamp]
- required: [duration]
SatSfInfo:
description: Represents the event report of satellite SF information.
type: object
properties:
satSfTrigger:
$ref: '#/components/schemas/SatSfTrigger'
tgtUe:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
ueSfMode:
$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/UeStrAndFwdStatus'
estTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
timeStamp:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
required:
- satSfTrigger
- tgtUe
RefUeCap:
description: >
Represents the capabilities of the reference UE.
type: object
properties:
refUECap:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
required:
- refUECap
# Simple data types and Enumerations
SEALEvent:
......@@ -903,6 +947,7 @@ components:
- GM_TEMP_GROUP_FORMATION
- LM_LOCATION_AREA_MONITOR
- GM_GROUP_DELETION
- NRM_SAT_SF_INFO
- type: string
description: >
This string provides forward-compatibility with future
......@@ -928,6 +973,7 @@ components:
- LM_LOCATION_AREA_MONITOR: Events from Location Management server, related to the list
of UEs moving in or moving out of the specific location.
- GM_GROUP_DELETION: Events related to deletion of existing VAL Group(s) from the GM Server.
- NRM_SAT_SF_INFO: Events related to satellite S&F information.
LocDevNotification:
anyOf:
......@@ -970,3 +1016,21 @@ components:
Possible values are:
- DISTANCE_TRAVELLED: This value indicates the trigger event for the location area
monitoring based on the distance travelled by the reference UE.
SatSfTrigger:
anyOf:
- type: string
enum:
- UE_SF_MODE
- EST_DELIVERY_TIME
- 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.
description: |
Identifies the triggering event in the location area monitor filtering.
Possible values are:
- UE_SF_MODE: Indicates that the triggering condition is the UE status in S&F mode.
- EST_DELIVERY_TIME: Indicates that the triggering condition is the DL S&F estimated
delivery time.
TS29549_SS_NetworkResourceAdaptation.yaml
View file @ 1a359940
openapi: 3.0.0
info:
version: 1.3.0-alpha.3
version: 1.3.0-alpha.4
title: SS_NetworkResourceAdaptation
description: |
SS Network Resource Adaptation Service.
......@@ -9,7 +9,7 @@ info:
externalDocs:
description: >
3GPP TS 29.549 V19.2.0; Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0; Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -687,6 +687,125 @@ paths:
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Update Individual Unicast Subscription resource.
operationId: UpdateUnicastSubscription
tags:
- Individual Unicast Subscription (Document)
parameters:
- name: uniSubId
in: path
description: Unicast Subscription ID
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UnicastSubscription'
responses:
'200':
description: >
Successful case. The "Individual Unicast Subscription" resource is
successfully updated and a representation of the updated resource is
returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/UnicastSubscription'
'204':
description: >
Successful case. The "Individual Unicast Subscription" resource is
successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Modify Individual Unicast Subscription resource.
operationId: ModifyUnicastSubscription
tags:
- Individual Unicast Subscription (Document)
parameters:
- name: uniSubId
in: path
description: Unicast Subscription ID
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UnicastSubscriptionPatch'
responses:
'200':
description: >
Successful case. The "Individual Unicast Subscription" resource is
successfully modified and a representation of the updated resource is returned
in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/UnicastSubscription'
'204':
description: >
Successful case. The "Individual Unicast Subscription" resource is
successfully modified and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: "Delete an existing Individual Unicast Subscription"
operationId: DeleteUnicastSubscription
......@@ -1586,11 +1705,20 @@ components:
- notifUri
UnicastSubscription:
description: Represents a unicast subscription.
description: Represents a network resource adaptation subscription.
type: object
properties:
valUes:
type: array
items:
type: string
minItems: 1
valGroupId:
type: string
valTgtUe:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
bdtId:
type: string
uniQosReq:
type: string
duration:
......@@ -1604,8 +1732,36 @@ components:
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- valTgtUe
- notifUri
oneOf:
- required: [valUes]
- required: [valGroupId]
- required: [valTgtUe]
UnicastSubscriptionPatch:
description: >
Represents the requested modifications to a network resource adaptation subscription.
type: object
properties:
valUes:
type: array
items:
type: string
minItems: 1
nullable: true
valGroupId:
type: string
nullable: true
valTgtUe:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUeRm'
bdtId:
type: string
uniQosReq:
type: string
duration:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
UserPlaneNotification:
description: Represents a notification on User Plane events.
......
TS29549_SS_SLPositioningManagement.yaml
View file @ 1a359940
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: SS_SLPositioningManagement
version: 1.0.0-alpha.1
version: 1.0.0-alpha.2
description: |
API for SEAL SL Positioning management Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.549 V19.1.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -319,6 +319,54 @@ paths:
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/request-srp:
post:
summary: Enables a service consumer to request SR positioning information.
operationId: RequestSRPosInfo
tags:
- SR Positioning Information Request
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SrPosInfoReq'
responses:
'200':
description: >
OK. The Positioning Information Request is successfully received and processed, and the
requested SR based positioning information is returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/SrPosInfoResp'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
......@@ -344,6 +392,11 @@ components:
description: List of VAL Users or UE IDs for which SL location management is requested.
valServArea:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
valUeSel:
type: array
items:
$ref: '#/components/schemas/ValUeSel'
minItems: 1
eventReport:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
notifUri:
......@@ -370,6 +423,11 @@ components:
description: List of VAL Users or UE IDs for which SL location management is requested.
valServArea:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
valUeSel:
type: array
items:
$ref: '#/components/schemas/ValUeSel'
minItems: 1
eventReport:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
notifUri:
......@@ -401,7 +459,10 @@ components:
minItems: 1
description: List of VAL UE(s) identified as Client UE(s).
failCause:
type: array
items:
$ref: '#/components/schemas/Cause'
minItems: 1
required:
- subscId
- refUes
......@@ -416,14 +477,97 @@ components:
description: Identity of the VAL UE ID.
valUeAddr:
$ref: 'TS29549_SS_NetworkResourceAdaptation.yaml#/components/schemas/ValUeAddrInfo'
SrPosInfoReq:
description: >
Represents the SR Positioning Information Request.
type: object
properties:
valSvcId:
type: string
ueList:
$ref: '#/components/schemas/SrUeList'
srPosFltr:
type: array
items:
$ref: '#/components/schemas/SrPosFilter'
minItems: 1
locQoS:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
required:
- ueList
- srPosFltr
SrPosInfoResp:
description: >
Represents the SR Positioning Information Response.
type: object
properties:
srPosInfo:
type: array
items:
$ref: '#/components/schemas/SrPosInfo'
minItems: 1
required:
- srPosInfo
SrUeList:
description: >
Contains the list of UE identities of Short-Range based positioning.
type: object
properties:
clientUes:
type: array
items:
type: string
minItems: 1
tgtUes:
type: array
items:
type: string
minItems: 1
refUes:
type: array
items:
type: string
minItems: 1
required:
- clientUes
- tgtUes
- refUes
SrPosInfo:
description: >
Contains the Short-Range based positioning information.
type: object
properties:
refUe:
type: string
tgtUe:
type: string
relativeLocation2D:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/2DRelativeLocation'
relativeLocation3D:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/3DRelativeLocation'
relativeVelocity:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelativeVelocityWithUncertainty'
distanceDirection:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RangeDirection'
required:
- refUe
- tgtUe
anyOf:
- required: [ relativeLocation2D ]
- required: [ relativeLocation3D ]
- required: [ relativeVelocity ]
- required: [ distanceDirection ]
# Simple data types and Enumerations
Cause:
anyOf:
- type: string
enum:
- NOTIFY_CRITERIA_MATCHED
- NOTIFY_NO_REFERENCE_UE_FOUND
- NOTIFY_NO_TARGET_UE_FOUND
- NOTIFY_NO_CLIENT_UE_FOUND
......@@ -435,11 +579,49 @@ components:
description: |
Possible values are:
Enumeration of SL Positioning management failure cause.
- NOTIFY_CRITERIA_MATCHED: This value indicates that the VAL UE in the report matches
to the criteria indicated in the subscription.
- NOTIFY_NO_REFERENCE_UE_FOUND: This value indicates that the none of the VAL UE matches
the criteria for the Reference UE.
- NOTIFY_NO_TARGET_UE_FOUND: This value indicates that the none of the VAL UE matches
the criteria for the Target UE.
- NOTIFY_NO_CLIENT_UE_FOUND: This value indicates that the none of the VAL UE matches
the criteria for the Client UE.
ValUeSel:
anyOf:
- type: string
enum:
- REF_UE
- TARGET_UE
- CLIENT_UE
- 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.
description: |
Possible values are:
Enumeration of VAL UE(s) selection criteria for SL Positioning management.
- REF_UE: Indicates the selection criteria of UE role is reference UE.
- TARGET_UE: Indicates the selection criteria of UE role is target UE.
- CLIENT_UE: Indicates the selection criteria of UE role is client UE.
SrPosFilter:
anyOf:
- type: string
enum:
- RANGE
- DIRECTION
- RELATIVE_POS
- RELATIVE_VEL
- 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.
description: |
Possible values are:
Enumeration of requested SR based positioning information filters.
- RANGE: Indicates that the range is requested.
- DIRECTION: Indicates that the direction is requested.
- RELATIVE_POS: Indicates that the relative position is requested.
- RELATIVE_VEL: Indicates that the relative velocity is requested.
TS29549_SS_UserProfileRetrieval.yaml
View file @ 1a359940
......@@ -4,13 +4,13 @@ info:
title: SS_UserProfileRetrieval
description: |
API for SEAL User Profile Retrieval.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.3.0-alpha.1"
version: "1.3.0-alpha.2"
externalDocs:
description: >
3GPP TS 29.549 V19.1.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -116,3 +116,18 @@ components:
oneOf:
- required: [valUserId]
- required: [valUeId]
ValTargetUeRm:
description: >
Represents the same as the ValTargetUe data type but with the OpenAPI
"nullable" property set to "true".
type: object
properties:
valUserId:
type: string
valUeId:
type: string
oneOf:
- required: [valUserId]
- required: [valUeId]
nullable: true
TS29549_SS_VALServiceAreaConfiguration.yaml
View file @ 1a359940
......@@ -4,13 +4,13 @@ info:
title: SS_VALServiceAreaConfiguration
description: |
API for SEAL VAL Service Area Configuration Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.1.0-alpha.1"
version: "1.1.0-alpha.2"
externalDocs:
description: >
3GPP TS 29.549 V19.0.0 Service Enabler Architecture Layer for Verticals (SEAL);
3GPP TS 29.549 V19.3.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
......@@ -560,7 +560,7 @@ components:
description: >
Represents the VAL Service Area identifier encoded as a string and generated
either based on VAL Server ID or using the Universally Unique Identifier (UUID)
version 4 as described in IETF RFC 4122.
version 4 as described in IETF RFC 9562.
ValServiceAreaSubsc:
description: Represents the VAL service area change event(s) subscription.
......
TS29550_Nsoraf_SOR.yaml
View file @ 1a359940
openapi: 3.0.0
info:
title: 'Nsoraf_SOR'
version: 1.2.0
version: 1.3.0-alpha.1
description: |
Nsoraf Steering Of Roaming Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.550 V18.3.0; Steering Of Roaming Application Function Services.
description: 3GPP TS 29.550 V19.0.0; Steering Of Roaming Application Function Services.
url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.550/
servers:
- url: '{apiRoot}/nsoraf-sor/v1'
......
TS29551_Nnef_PFDmanagement.yaml
View file @ 1a359940
openapi: 3.0.0
info:
title: Nnef_PFDmanagement Service API
version: 1.4.0-alpha.1
version: 1.4.0-alpha.2
description: |
Packet Flow Description Management Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
#
externalDocs:
description: 3GPP TS 29.551 v19.1.0, 5G System; Packet Flow Description Management Service
description: 3GPP TS 29.551 v19.2.0, 5G System; Packet Flow Description Management Service
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.551/'
#
servers:
......
TS29553_Npanf_ProseKey.yaml
View file @ 1a359940
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: Npanf_ProseKey
version: 1.1.0
version: 1.2.0-alpha.1
description: |
PAnF ProseKey Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.553 V18.4.0; 5G System; 5G ProSe Anchor Services; Stage 3.
description: 3GPP TS 29.553 V19.0.0; 5G System; 5G ProSe Anchor Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.553/
servers:
......