Skip to content
GitLab
Explore
Sign in
Show whitespace changes
Inline
Side-by-side
TS29517_Naf_EventExposure.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.4.0-alpha.
3
version
:
1.4.0-alpha.
4
title
:
Naf_EventExposure
description
:
|
AF Event Exposure Service.
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.517 V19.
2
.0; 5G System; Application Function Event Exposure Service; Stage 3.
3GPP TS 29.517 V19.
3
.0; 5G System; Application Function Event Exposure Service; Stage 3.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.517/
servers
:
...
...
TS29518_Namf_AIoT.yaml
0 → 100644
View file @
eee1c11e
openapi
:
3.0.0
info
:
title
:
Namf_AIoT
version
:
1.0.0-alpha.1
description
:
|
AMF AIoT Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.518 V19.3.0; 5G System; Access and Mobility Management Services
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers
:
-
url
:
'
{apiRoot}/namf-aiot/v1'
variables
:
apiRoot
:
default
:
https://example.com
description
:
apiRoot as defined in clause 4.4 of 3GPP TS
29.501
security
:
-
{}
-
oAuth2ClientCredentials
:
-
namf-aiot
paths
:
/deliver
:
post
:
summary
:
Request to transfer AIoT data towards NG-RAN or AIoT devices.
operationId
:
MessageDelivery
tags
:
-
AIoT Message Delivery Request (custom operation without associated resources)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/AiotMessageReq'
multipart/related
:
# message with binary body part(s)
schema
:
type
:
object
properties
:
# Request parts
jsonData
:
$ref
:
'
#/components/schemas/AiotMessageReq'
binaryDataN2Information
:
type
:
string
format
:
binary
encoding
:
jsonData
:
contentType
:
application/json
binaryDataN2Information
:
contentType
:
application/vnd.3gpp.ngap
headers
:
Content-Id
:
schema
:
type
:
string
responses
:
'
204'
:
description
:
>
No Content. The message is successfully received and processed.
'
307'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
'
503'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/default'
callbacks
:
AIoTInformationNotif
:
'
{$request.body#/notifUri}'
:
post
:
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/AiotInfoNotification'
multipart/related
:
# message with binary body part(s)
schema
:
type
:
object
properties
:
jsonData
:
$ref
:
'
#/components/schemas/AiotInfoNotification'
binaryDataN2Information
:
type
:
string
format
:
binary
encoding
:
jsonData
:
contentType
:
application/json
binaryDataN2Information
:
contentType
:
application/vnd.3gpp.ngap
headers
:
Content-Id
:
schema
:
type
:
string
responses
:
'
204'
:
description
:
>
No Content. The AIoT Information Notification is successfully received and
acknowledged.
'
307'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
'
503'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/default'
components
:
securitySchemes
:
oAuth2ClientCredentials
:
type
:
oauth2
flows
:
clientCredentials
:
tokenUrl
:
'
{nrfApiRoot}/oauth2/token'
scopes
:
namf-aiot
:
Access to the Namf_AIoT API.
schemas
:
#
# STRUCTURED DATA TYPES
#
AiotMessageReq
:
description
:
Represents the AIoT message delivery request.
type
:
object
properties
:
ranNodeId
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId'
aiotMessage
:
$ref
:
'
#/components/schemas/AiotMessage'
aiotMessageType
:
$ref
:
'
#/components/schemas/AiotMessageType'
notifUri
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
ranNodeId
-
aiotMessage
-
notifUri
-
aiotMessageType
AiotInfoNotification
:
description
:
Represents the AIoT information notification.
type
:
object
properties
:
aiotMessage
:
$ref
:
'
#/components/schemas/AiotMessage'
required
:
-
aiotMessage
AiotMessage
:
description
:
Represents the AIoT message from or to NG-RAN.
type
:
object
properties
:
ngapMessageType
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
aiotNgapData
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/RefToBinaryData'
required
:
-
aiotNgapData
-
ngapMessageType
AiotMessageType
:
description
:
AIoT NGAP Message Type
anyOf
:
-
type
:
string
enum
:
-
INVENTORY
-
COMMAND
-
type
:
string
TS29518_Namf_Communication.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.4.0-alpha.
3
version
:
1.4.0-alpha.
4
title
:
Namf_Communication
description
:
|
AMF Communication Service.
...
...
@@ -14,7 +14,7 @@ security:
-
namf-comm
externalDocs
:
description
:
3GPP TS 29.518 V19.
2
.0; 5G System; Access and Mobility Management Services
description
:
3GPP TS 29.518 V19.
3
.0; 5G System; Access and Mobility Management Services
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers
:
...
...
@@ -2976,6 +2976,8 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/RfspIndex'
pcfRfsp
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/RfspIndex'
chfGroupId
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfGroupId'
usedRfsp
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/RfspIndex'
subUeAmbr
:
...
...
@@ -3206,6 +3208,9 @@ components:
type
:
boolean
uePolicyInd
:
type
:
boolean
energySavingInd
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/EnergySavingIndicator'
...
...
@@ -4033,7 +4038,9 @@ components:
-
$ref
:
'
#/components/schemas/AmfEventSubscriptionAddInfo'
AmfEventSubscriptionAddInfo
:
description
:
Additional information received for an AMF event subscription, e.g. binding indications
description
:
>
Additional information received for an AMF event subscription, e.g. binding indications,
statistical information for UE access behavior trends report or UE location trends report.
type
:
object
properties
:
bindingInfo
:
...
...
@@ -4068,6 +4075,18 @@ components:
type
:
boolean
enum
:
-
true
ueAccessBehaviorTrends
:
type
:
array
items
:
$ref
:
'
TS29518_Namf_EventExposure.yaml#/components/schemas/UeAccessBehaviorReportItem'
minItems
:
1
ueLocationTrends
:
type
:
array
items
:
$ref
:
'
TS29518_Namf_EventExposure.yaml#/components/schemas/UeLocationTrendsReportItem'
minItems
:
1
UeDifferentiationInfo
:
description
:
Represents the UE Differentiation Information and its validity time
...
...
TS29518_Namf_EventExposure.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.4.0-alpha.
2
version
:
1.4.0-alpha.
3
title
:
Namf_EventExposure
description
:
|
AMF Event Exposure Service.
...
...
@@ -14,7 +14,7 @@ security:
-
namf-evts
externalDocs
:
description
:
3GPP TS 29.518 V19.
2
.0; 5G System; Access and Mobility Management Services
description
:
3GPP TS 29.518 V19.
3
.0; 5G System; Access and Mobility Management Services
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers
:
...
...
@@ -697,6 +697,8 @@ components:
items
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/TimeWindow'
minItems
:
1
uavAltitudeReportingConfig
:
$ref
:
'
#/components/schemas/UavAltitudeReportingConfig'
required
:
-
type
...
...
@@ -832,7 +834,10 @@ components:
uePosCap
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/UePositioningCapabilities'
ueUpPosCap
:
type
:
array
items
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/UeUpPositioningCapabilities'
minItems
:
1
signallingMeasurementInfo
:
$ref
:
'
#/components/schemas/SignallingMeasurementInfo'
required
:
...
...
@@ -927,6 +932,9 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
oldGuami
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Guami'
udrRestartInd
:
type
:
boolean
default
:
false
required
:
-
subscription
AmfCreatedEventSubscription
:
...
...
@@ -1053,7 +1061,11 @@ components:
uePosCap
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/UePositioningCapabilities'
ueUpPosCap
:
type
:
array
items
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/UeUpPositioningCapabilities'
minItems
:
1
AmfEventSubsSyncInfo
:
description
:
AMF Event Subscriptions Information for synchronization
...
...
@@ -1131,8 +1143,16 @@ components:
$ref
:
'
#/components/schemas/AccessStateTransitionType'
spacing
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
spacingVar
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
duration
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
durationVar
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
occurrences
:
type
:
integer
timestamp
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DateTime'
required
:
-
stateTransitionType
-
spacing
...
...
@@ -1196,8 +1216,14 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/N3gaLocation'
spacing
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
spacingVar
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
duration
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
durationVar
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
occurrences
:
type
:
integer
timestamp
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DateTime'
required
:
...
...
@@ -1295,8 +1321,26 @@ components:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
altitudeHigh
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
required
:
-
taiList
ranNodeIdList
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId'
minItems
:
1
ncgiList
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Ncgi'
minItems
:
1
ecgiList
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Ecgi'
minItems
:
1
anyOf
:
-
required
:
[
taiList
]
-
required
:
[
ranNodeIdList
]
-
required
:
[
ncgiList
]
-
required
:
[
ecgiList
]
TrajectorySegment
:
description
:
Trajectory segment
...
...
@@ -1324,6 +1368,8 @@ components:
items
:
$ref
:
'
#/components/schemas/TrajectorySegment'
minItems
:
1
acceptableDeviationTime
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
SmCommFailureFilter
:
description
:
Filter for Session Management Communication Failure
...
...
@@ -1344,7 +1390,26 @@ components:
nfSignallingInfo
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfSignallingInfo'
UavAltitudeReportingConfig
:
description
:
altitude reporting
type
:
object
properties
:
rptThresholdMin
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
rptThresholdMax
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
altReportPeriod
:
type
:
integer
minimum
:
120
maximum
:
1800000
altReportEventTrigger
:
type
:
array
items
:
$ref
:
'
#/components/schemas/AltReportEventTrigger'
minItems
:
1
required
:
-
rptThresholdMin
-
rptThresholdMax
AmfEventType
:
description
:
Describes the supported event types of Namf_EventExposure Service
...
...
@@ -1374,6 +1439,7 @@ components:
-
UE_MM_TRANSACTION_REPORT
-
TRAJECTORY_TRACKING_REPORT
-
SIGNALLING_MEASUREMENT_REPORT
-
ALTITUDE_REPORT
-
type
:
string
...
...
@@ -1496,3 +1562,12 @@ components:
-
TRAJECTORY_DEVIATED
-
TRAJECTORY_SEGMENT_CHANGE
-
type
:
string
AltReportEventTrigger
:
description
:
the event-based altitude reporting requirement reason.
anyOf
:
-
type
:
string
enum
:
-
TA_CHANGE
-
RAN_NODE
-
type
:
string
TS29518_Namf_Location.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.4.0-alpha.
3
version
:
1.4.0-alpha.
4
title
:
Namf_Location
description
:
|
AMF Location Service.
...
...
@@ -14,7 +14,7 @@ security:
-
namf-loc
externalDocs
:
description
:
3GPP TS 29.518 V19.
2
.0; 5G System; Access and Mobility Management Services
description
:
3GPP TS 29.518 V19.
3
.0; 5G System; Access and Mobility Management Services
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers
:
...
...
TS29518_Namf_MBSBroadcast.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.2.0-alpha.
1
version
:
1.2.0-alpha.
2
title
:
Namf_MBSBroadcast
description
:
|
AMF MBSBroadcast Service.
...
...
@@ -9,7 +9,7 @@ info:
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.518 V19.
2
.0; 5G System; Access and Mobility Management Services
description
:
3GPP TS 29.518 V19.
3
.0; 5G System; Access and Mobility Management Services
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers
:
...
...
TS29518_Namf_MBSCommunication.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.2.0-alpha.
1
version
:
1.2.0-alpha.
2
title
:
Namf_MBSCommunication
description
:
|
AMF Communication Service for MBS.
...
...
@@ -9,7 +9,7 @@ info:
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.518 V19.
2
.0; 5G System; Access and Mobility Management Services
description
:
3GPP TS 29.518 V19.
3
.0; 5G System; Access and Mobility Management Services
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers
:
...
...
TS29518_Namf_MT.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.4.0-alpha.
1
version
:
1.4.0-alpha.
2
title
:
Namf_MT
description
:
|
AMF Mobile Terminated Service.
...
...
@@ -14,7 +14,7 @@ security:
-
namf-mt
externalDocs
:
description
:
3GPP TS 29.518 V19.
2
.0; 5G System; Access and Mobility Management Services
description
:
3GPP TS 29.518 V19.
3
.0; 5G System; Access and Mobility Management Services
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'
servers
:
...
...
TS29519_Application_Data.yaml
View file @
eee1c11e
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.519 V19.
2
.0; 5G System; Usage of the Unified Data Repository Service for Policy Data,
3GPP TS 29.519 V19.
3
.0; 5G System; Usage of the Unified Data Repository Service for Policy Data,
Application Data and Structured Data for Exposure.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/'
...
...
@@ -3799,6 +3799,39 @@ paths:
required
:
true
schema
:
type
:
string
-
name
:
dnns
in
:
query
description
:
Each element identifies a DNN.
required
:
false
style
:
form
explode
:
false
schema
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Dnn'
minItems
:
1
-
name
:
snssais
in
:
query
description
:
Each element identifies a slice.
required
:
false
content
:
application/json
:
schema
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems
:
1
-
name
:
supis
in
:
query
description
:
Each element identifies a subscriber.
required
:
false
style
:
form
explode
:
false
schema
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Supi'
minItems
:
1
responses
:
'
200'
:
description
:
>
...
...
@@ -3979,7 +4012,7 @@ paths:
summary
:
Delete an Individual Non-3GPP Device Identifier Information resource
operationId
:
DeleteIndividualNo3GPPDevInfo
tags
:
-
Individual Non
3GPP Device Identifier Information (Document)
-
Individual Non
-
3GPP Device Identifier Information (Document)
security
:
-
{}
-
oAuth2ClientCredentials
:
...
...
@@ -3995,7 +4028,7 @@ paths:
-
name
:
non3gppDevId
in
:
path
description
:
>
The Identifier of an Individual Non-3GPP Device Identifier Information to be
upda
ted.
The Identifier of an Individual Non-3GPP Device Identifier Information to be
dele
ted.
required
:
true
schema
:
type
:
string
...
...
@@ -4571,12 +4604,15 @@ components:
items
:
$ref
:
'
TS29522_ServiceParameter.yaml#/components/schemas/Event'
minItems
:
1
description
:
Contains the outcome of the UE Policy Delivery.
description
:
>
Contains the outcome of the UE Policy Delivery and/or events related to service
parameters not authorized by the PCF.
policDelivNotifCorreId
:
type
:
string
description
:
>
Contains the Notification Correlation Id allocated by the NEF for the notification
of UE Policy delivery outcome.
of UE Policy delivery outcome and/or the notification about service parameters not
authorized by the PCF.
policDelivNotifUri
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uri'
suppFeat
:
...
...
@@ -4668,7 +4704,9 @@ components:
$ref
:
'
TS29522_ServiceParameter.yaml#/components/schemas/Event'
minItems
:
1
nullable
:
true
description
:
Contains the outcome of the UE Policy Delivery.
description
:
>
Contains the outcome of the UE Policy Delivery and/or events related to service
parameters not authorized by the PCF.
policDelivNotifUri
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uri'
headers
:
...
...
@@ -4743,8 +4781,8 @@ components:
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo'
minItems
:
1
description
:
Indicates the service area coverage requirement.
afSliceReplInfo
:
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/SliceReplInfo'
afSliceRepl
Req
Info
:
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/SliceRepl
Req
Info'
supportedFeatures
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
resUri
:
...
...
@@ -4758,7 +4796,7 @@ components:
-
anyOf
:
-
required
:
[
thruReq
]
-
required
:
[
covReq
]
-
required
:
[
afSliceReplInfo
]
-
required
:
[
afSliceRepl
Req
Info
]
-
oneOf
:
-
required
:
[
supi
]
-
required
:
[
interGroupId
]
...
...
@@ -4813,8 +4851,8 @@ components:
minItems
:
1
description
:
Indicates the service area coverage requirement.
nullable
:
true
afSliceReplInfo
:
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml
#/components/schemas/SliceReplInfo'
afSliceRepl
Req
Info
:
$ref
:
'
#/components/schemas/SliceRepl
Req
Info
Rm
'
ApplicationDataSubs
:
description
:
Identifies a subscription to application data change notification.
...
...
@@ -5071,9 +5109,9 @@ components:
-
required
:
[
qosReference
]
-
required
:
[
qosReqs
]
-
not
:
required
:
[
qosReference
,
altSerReqs
]
required
:
[
qosReference
,
altSerReqs
Data
]
-
not
:
required
:
[
alt
Qos
Reqs
,
altSerReqsData
]
required
:
[
alt
Ser
Reqs
,
altSerReqsData
]
AfRequestedQosDataPatch
:
description
:
Represents the requested modifications to AF Requested QoS data.
...
...
@@ -5298,6 +5336,25 @@ components:
$ref
:
'
TS29522_ServiceParameter.yaml#/components/schemas/Non3gppDeviceInformation'
minItems
:
1
SliceReplReqInfoRm
:
description
:
>
Represents the same as the SliceReplReqInfo data type defined in clause 5.6.2.12 of
3GPP TS 29.534 [22] but with the OpenAPI "nullable" property set to "true".
type
:
object
properties
:
snssai
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Snssai'
altSnssai
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Snssai'
nullable
:
true
required
:
-
snssai
-
altSnssai
#
# ENUMERATIONS
#
DataInd
:
anyOf
:
-
type
:
string
...
...
@@ -5310,6 +5367,7 @@ components:
-
DNAI_EAS
-
REQ_QOS
-
ECS
-
N3GDEV
-
type
:
string
description
:
>
This string provides forward-compatibility with future
...
...
@@ -5326,6 +5384,7 @@ components:
- DNAI_EAS: DNAI EAS mapping data.
- REQ_QOS: AF Requested QoS data for a UE or group of UE(s) not identified by UE address(es).
- ECS: ECS Address Roaming data.
- N3GDEV: Non-3gpp Device Identifier Information.
CorrelationType
:
description
:
Indicates that a common DNAI or common EAS should be selected.
...
...
TS29519_Exposure_Data.yaml
View file @
eee1c11e
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.519 V19.
2
.0; 5G System; Usage of the Unified Data Repository Service for Policy Data,
3GPP TS 29.519 V19.
3
.0; 5G System; Usage of the Unified Data Repository Service for Policy Data,
Application Data and Structured Data for Exposure.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/'
...
...
TS29519_Policy_Data.yaml
View file @
eee1c11e
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.519 V19.
2
.0; 5G System; Usage of the Unified Data Repository Service for Policy Data,
3GPP TS 29.519 V19.
3
.0; 5G System; Usage of the Unified Data Repository Service for Policy Data,
Application Data and Structured Data for Exposure.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/'
...
...
@@ -2804,6 +2804,12 @@ components:
description
:
>
Indicates whether the BDT warning notification is enabled (true) or not (false).
Default value is false.
energyInd
:
type
:
boolean
description
:
>
Indicates whether the AF is interested in transferring data in time windows
that consume lower energy.
default
:
false
notifUri
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uri'
suppFeat
:
...
...
TS29520_Nnwdaf_AnalyticsInfo.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.4.0-alpha.
2
version
:
1.4.0-alpha.
3
title
:
Nnwdaf_AnalyticsInfo
description
:
|
Nnwdaf_AnalyticsInfo Service API.
...
...
@@ -9,7 +9,7 @@ info:
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/'
security
:
...
...
@@ -338,6 +338,11 @@ components:
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/SignalStormInfo'
minItems
:
1
qosPlyAsstInfos
:
type
:
array
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/QosPolicyAssistInfo'
minItems
:
1
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
...
...
@@ -550,6 +555,11 @@ components:
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/SignalStormReq'
minItems
:
1
qosPlyAssistReqs
:
type
:
array
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/QosPolicyAssistReq'
minItems
:
1
not
:
required
:
[
anySlice
,
snssais
]
...
...
TS29520_Nnwdaf_DataManagement.yaml
View file @
eee1c11e
...
...
@@ -2,14 +2,14 @@ openapi: 3.0.0
info
:
title
:
Nnwdaf_DataManagement
version
:
1.2.0-alpha.
1
version
:
1.2.0-alpha.
2
description
:
|
Nnwdaf_DataManagement API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/'
servers
:
...
...
TS29520_Nnwdaf_EventsSubscription.yaml
View file @
eee1c11e
openapi
:
3.0.0
info
:
version
:
1.4.0-alpha.
2
version
:
1.4.0-alpha.
3
title
:
Nnwdaf_EventsSubscription
description
:
|
Nnwdaf_EventsSubscription Service API.
...
...
@@ -9,7 +9,7 @@ info:
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/'
security
:
...
...
@@ -564,6 +564,11 @@ components:
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/BitRate'
minItems
:
1
e2eDelayThds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
minItems
:
1
repetitionPeriod
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
snssaia
:
...
...
@@ -710,6 +715,12 @@ components:
$ref
:
'
#/components/schemas/SignalStormReq'
minItems
:
1
description
:
Represents the signalling storm analytics requirements.
qosPolAssistReqs
:
type
:
array
items
:
$ref
:
'
#/components/schemas/QosPolicyAssistReq'
minItems
:
1
description
:
Represents the QoS and policy assistance analytics requirements.
required
:
-
event
not
:
...
...
@@ -899,6 +910,12 @@ components:
$ref
:
'
#/components/schemas/SignalStormInfo'
minItems
:
1
description
:
The signalling storm information.
qosPolAssistInfos
:
type
:
array
items
:
$ref
:
'
#/components/schemas/QosPolicyAssistInfo'
minItems
:
1
description
:
The QoS and policy assistance information.
required
:
-
event
...
...
@@ -1350,6 +1367,8 @@ components:
$ref
:
'
#/components/schemas/RetainabilityThreshold'
ranUeThrouThd
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/BitRate'
e2eDelayThd
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
snssai
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Snssai'
confidence
:
...
...
@@ -1357,6 +1376,7 @@ components:
oneOf
:
-
required
:
[
qosFlowRetThd
]
-
required
:
[
ranUeThrouThd
]
-
required
:
[
e2eDelayThd
]
QosRequirement
:
description
:
Represents the QoS requirements.
...
...
@@ -2994,6 +3014,16 @@ components:
minItems
:
1
ttcInfo
:
$ref
:
'
#/components/schemas/TimeToCollisionInfo'
intGroupIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/GroupId'
minItems
:
1
exterGroupIds
:
type
:
array
items
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
minItems
:
1
required
:
-
tsStart
-
tsDuration
...
...
@@ -3124,12 +3154,12 @@ components:
description
:
The signalling storm analytics requirement information.
type
:
object
properties
:
n
fInstanceIds
:
tgtN
fInstanceIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems
:
1
n
fSetIds
:
tgtN
fSetIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfSetId'
...
...
@@ -3173,34 +3203,34 @@ components:
description
:
The signalling storm analytics information.
type
:
object
properties
:
n
fInstanceIds
:
tgtN
fInstanceIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems
:
1
description
:
The NF instance ID(s) of the NFs impacted by the signaling storm.
n
fSetIds
:
description
:
The NF instance ID(s) of the
target
NFs impacted by the signal
l
ing storm.
tgtN
fSetIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfSetId'
minItems
:
1
description
:
The NF set ID(s) of the NFs impacted by the signaling storm.
i
ntGroupIds
:
description
:
The NF set ID(s) of the
target
NFs impacted by the signal
l
ing storm.
srcI
ntGroupIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/GroupId'
minItems
:
1
e
xterGroupIds
:
srcE
xterGroupIds
:
type
:
array
items
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/ExternalGroupId'
minItems
:
1
supis
:
s
rcS
upis
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Supi'
minItems
:
1
g
psis
:
srcG
psis
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Gpsi'
...
...
@@ -3216,13 +3246,13 @@ components:
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems
:
1
description
:
The NF instance ID(s) of the NFs which cause the signalling storm.
description
:
The NF instance ID(s) of the
source
NFs which cause the signalling storm.
srcNfSetIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfSetId'
minItems
:
1
description
:
The NF set ID(s) of the NFs which cause the signalling storm.
description
:
The NF set ID(s) of the
source
NFs which cause the signalling storm.
sigInfo
:
type
:
array
items
:
...
...
@@ -3243,14 +3273,9 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
required
:
-
sigStormCauses
allOf
:
-
oneOf
:
-
required
:
[
nfInstanceIds
]
-
required
:
[
nfSetIds
]
-
oneOf
:
-
required
:
[
srcNfInstanceIds
]
-
required
:
[
srcNfSetIds
]
-
required
:
[
intGroupIds
]
oneOf
:
-
required
:
[
tgtNfInstanceIds
]
-
required
:
[
tgtNfSetIds
]
SignalInfo
:
description
:
Represents the signalling information..
...
...
@@ -3295,6 +3320,157 @@ components:
timerDur
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
QosPolicyAssistReq
:
description
:
The QoS and policy assistance analytics requirement information.
type
:
object
properties
:
orderCriterion
:
$ref
:
'
#/components/schemas/QosPolOrderCriterion'
orderDirection
:
$ref
:
'
#/components/schemas/MatchingDirection'
freqs
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ArfcnValueNR'
minItems
:
1
ratTypes
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/RatType'
minItems
:
1
qosParamSets
:
type
:
array
items
:
$ref
:
'
#/components/schemas/QosPara'
minItems
:
1
requestedQoe
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
required
:
-
qosParamSets
QosPolicyAssistInfo
:
description
:
The QoS and policy assistance analytics information.
type
:
object
properties
:
qosPolAssistInfo
:
type
:
array
items
:
$ref
:
'
#/components/schemas/QosPolicyAssistSetsPerTS'
minItems
:
1
description
:
The QoS and policy assistance information.
QosPolicyAssistSet
:
description
:
The QoS and policy assistance parameter set.
type
:
object
properties
:
qosParamSet
:
$ref
:
'
#/components/schemas/QosPara'
dnn
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Dnn'
appId
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ApplicationId'
fDescs
:
type
:
array
items
:
$ref
:
'
#/components/schemas/IpEthFlowDescription'
minItems
:
1
appDuration
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
predictedAvgQoe
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
predictedMaxQoe
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
predictedMinQoe
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
predQoeVariance
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
qosPolTimeWin
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/TimeWindow'
freqs
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ArfcnValueNR'
minItems
:
1
ratTypes
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/RatType'
minItems
:
1
validityPeriod
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/TimeWindow'
spatialValidity
:
$ref
:
'
TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo'
maxQoSFlowUsgDur
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
minQoSFlowUsgDur
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
avgQoSFlowUsgDur
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
qosFlowUsgNumber
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
anyOf
:
-
required
:
[
predictedAvgQoe
]
-
required
:
[
predictedMaxQoe
]
-
required
:
[
predictedMinQoe
]
-
required
:
[
predQoeVariance
]
oneOf
:
-
required
:
[
appId
]
-
required
:
[
fDescs
]
QosPolicyAssistSetsPerTS
:
description
:
The QoS and policy assistance parameter sets per Time Slot.
type
:
object
properties
:
tsStart
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DateTime'
tsDuration
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
qosPolAssistSets
:
type
:
array
items
:
$ref
:
'
#/components/schemas/QosPolicyAssistSet'
minItems
:
1
confidence
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
required
:
-
tsStart
-
tsDuration
-
qosPolAssistSets
QosPara
:
description
:
The values of the QoS parameters.
type
:
object
properties
:
qosParamSetId
:
type
:
string
description
:
Identifies the QoS parameter set.
5qi
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/5Qi'
priorityLvl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel'
rscType
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/QosResourceType'
pdb
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
per
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PacketErrRate'
gbrUl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/BitRate'
gbrDl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/BitRate'
mbrUl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/BitRate'
mbrDl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/BitRate'
maxPlrUl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
maxPlrDl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PacketLossRate'
avgWin
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/AverWindow'
maxDataBurstVol
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVol'
#
# ENUMERATIONS DATA TYPES
#
...
...
@@ -3343,6 +3519,7 @@ components:
-
LOC_ACCURACY
-
RELATIVE_PROXIMITY
-
SIGNALLING_STORM
-
QOS_POLICY_ASSIST
-
type
:
string
description
:
>
This string provides forward-compatibility with future
...
...
@@ -3384,6 +3561,8 @@ components:
- RELATIVE_PROXIMITY: Indicates that the event subscribed is the Relative Proximity
information.
- SIGNALLING_STORM: Indicates that the event subscribed is the Signalling Storm information.
- QOS_POLICY_ASSIST: Indicates that the event subscribed is the QoS and Policy
Assistance information.
Accuracy
:
anyOf
:
...
...
@@ -4346,3 +4525,21 @@ components:
Possible values are:
- PERIODICITY_TIMER: The type of the timer is periodicity.
- BACKOFF_TIMER: The type of the timer is back-off.
QosPolOrderCriterion
:
anyOf
:
-
type
:
string
enum
:
-
QOE
-
USAGE_DURATION
-
NUMBER_OF_USAGES
-
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:
- QOE: Indicates the order is the QoE.
- USAGE_DURATION: Indicates the order is the QoS Flow Usage Duration.
- NUMBER_OF_USAGES: Indicates the order is the number of usages of the QoS Flow.
TS29520_Nnwdaf_MLModelMonitor.yaml
View file @
eee1c11e
...
...
@@ -2,14 +2,14 @@ openapi: 3.0.0
info
:
title
:
Nnwdaf_MLModelMonitor
version
:
1.1.0-alpha.
1
version
:
1.1.0-alpha.
2
description
:
|
Nnwdaf_MLModelMonitor API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/
servers
:
...
...
TS29520_Nnwdaf_MLModelProvision.yaml
View file @
eee1c11e
...
...
@@ -2,14 +2,14 @@ openapi: 3.0.0
info
:
title
:
Nnwdaf_MLModelProvision
version
:
1.2.0-alpha.
2
version
:
1.2.0-alpha.
3
description
:
|
Nnwdaf_MLModelProvision API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/
servers
:
...
...
TS29520_Nnwdaf_MLModelTraining.yaml
View file @
eee1c11e
...
...
@@ -2,14 +2,14 @@ openapi: 3.0.0
info
:
title
:
Nnwdaf_MLModelTraining
version
:
1.1.0-alpha.
3
version
:
1.1.0-alpha.
4
description
:
|
Nnwdaf_MLModelTraining API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/
servers
:
...
...
TS29520_Nnwdaf_RoamingAnalytics.yaml
View file @
eee1c11e
...
...
@@ -2,14 +2,14 @@ openapi: 3.0.0
info
:
title
:
Nnwdaf_RoamingAnalytics
version
:
1.1.0-alpha.
1
version
:
1.1.0-alpha.
2
description
:
|
Nnwdaf_RoamingAnalytics API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/
servers
:
...
...
TS29520_Nnwdaf_RoamingData.yaml
View file @
eee1c11e
...
...
@@ -2,14 +2,14 @@ openapi: 3.0.0
info
:
title
:
Nnwdaf_RoamingData
version
:
1.1.0-alpha.
1
version
:
1.1.0-alpha.
2
description
:
|
Nnwdaf_RoamingData API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.
2
.0; 5G System; Network Data Analytics Services.
description
:
3GPP TS 29.520 V19.
3
.0; 5G System; Network Data Analytics Services.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/
servers
:
...
...
TS29520_Nnwdaf_VFLInference.yaml
0 → 100644
View file @
eee1c11e
openapi
:
3.0.0
info
:
title
:
Nnwdaf_VFLInference
version
:
1.0.0-alpha.1
description
:
|
Nnwdaf_VflInference API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.520 V19.3.0; 5G System; Network Data Analytics Services.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/
servers
:
-
url
:
'
{apiRoot}/nnwdaf-vflinference/v1'
variables
:
apiRoot
:
default
:
https://example.com
description
:
apiRoot as defined in clause 4.4 of 3GPP TS
29.501
security
:
-
{}
-
oAuth2ClientCredentials
:
-
nnwdaf-vflinference
paths
:
/subscriptions
:
post
:
summary
:
Create a new Individual NWDAF VFL Inference Subscription resource.
operationId
:
CreateNWDAFVFLInferenceSubcription
tags
:
-
Subscriptions (Collection)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflInferSub'
responses
:
'
201'
:
description
:
Create a new Individual NWDAF VFL Inference Subscription resource.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflInferSub'
headers
:
Location
:
description
:
>
Contains the URI of the newly created resource, according to the
structure
{apiRoot}/nnwdaf-vflinference/v1/subscriptions/{subscriptionId}.
required
:
true
schema
:
type
:
string
'
400'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
'
503'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/default'
callbacks
:
myNotification
:
'
{$request.body#/notifUri}'
:
post
:
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflInferNotif'
responses
:
'
204'
:
description
:
No Content, Notification was succesfull
'
307'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
'
503'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}
:
put
:
summary
:
update an existing Individual NWDAF VFL Inference Subscription
operationId
:
UpdateNWDAFVFLInferenceSubcription
tags
:
-
Individual NWDAF VFL Inference Subscription (Document)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflInferSub'
parameters
:
-
name
:
subscriptionId
in
:
path
description
:
String identifying a subscription to the Nnwdaf_VFLInference Service.
required
:
true
schema
:
type
:
string
responses
:
'
200'
:
description
:
>
The Individual NWDAF VFL Inference Subscription resource was modified
successfully and a representation of that resource is returned.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflInferSub'
'
204'
:
description
:
>
The Individual NWDAF VFL Inference Subscription resource was modified
successfully.
'
307'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
'
503'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/default'
patch
:
summary
:
partial update an existing Individual NWDAF VFL Inference Subscription
operationId
:
PartialUpdateNWDAFVFLInferenceSubcription
tags
:
-
Individual NWDAF VFL Inference Subscription (Document)
requestBody
:
required
:
true
content
:
application/merge-patch+json
:
schema
:
$ref
:
'
#/components/schemas/VflInferSubPatch'
parameters
:
-
name
:
subscriptionId
in
:
path
description
:
String identifying a subscription to the Nnwdaf_VflInference Service.
required
:
true
schema
:
type
:
string
responses
:
'
200'
:
description
:
>
The Individual NWDAF VFL Inference Subscription resource was partial
modified successfully and a representation of that resource is returned.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflInferSub'
'
204'
:
description
:
>
The Individual NWDAF VFL Inference Subscription resource was partial
modified successfully.
'
307'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
'
503'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/default'
delete
:
summary
:
Delete an existing Individual NWDAF VFL Inference Subscription.
operationId
:
DeleteNWDAFVFLInferenceSubcription
tags
:
-
Individual NWDAF VFL Inference Subscription (Document)
parameters
:
-
name
:
subscriptionId
in
:
path
description
:
>
String identifying a subscription to the Nnwdaf_VFLInference Service.
required
:
true
schema
:
type
:
string
responses
:
'
204'
:
description
:
>
No Content. The Individual NWDAF VFL Inference Subscription matching the
subscriptionId was deleted.
'
307'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/404'
'
429'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
'
503'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/default'
components
:
securitySchemes
:
oAuth2ClientCredentials
:
type
:
oauth2
flows
:
clientCredentials
:
tokenUrl
:
'
{nrfApiRoot}/oauth2/token'
scopes
:
nnwdaf-vflinference
:
Access to the Nnwdaf_VflInference API
schemas
:
VflInferSub
:
description
:
Represents a VFL Inference subscription.
type
:
object
properties
:
notifCorreId
:
type
:
string
description
:
>
String identifying the Notification Correlation ID in the corresponding
notification.
notifUri
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uri'
suppFeats
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
vflInferAnaSub
:
$ref
:
'
#/components/schemas/VflInferAnaSub'
vflInferReq
:
$ref
:
'
#/components/schemas/VflInferReq'
vflInferResults
:
type
:
array
items
:
$ref
:
'
#/components/schemas/VflInferResult'
minItems
:
1
description
:
Represents intermediate VFL Inference result.
vflReportInfo
:
$ref
:
'
TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
required
:
-
notifUri
-
notifCorreId
-
vflInferAnaSub
VflInferNotif
:
description
:
Represents notifications on events that occurred.
type
:
object
properties
:
notifCorreId
:
type
:
string
description
:
>
String identifying the Notification Correlation ID in the corresponding
notification.
vflInferResults
:
type
:
array
items
:
$ref
:
'
#/components/schemas/VflInferResult'
minItems
:
1
description
:
Represents intermediate VFL inference results.
required
:
-
notifCorreId
-
vflInferResults
VflInferSubPatch
:
description
:
>
Represents parameters to request the modification of a VFL Inference
subscription.
type
:
object
properties
:
notifUri
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uri'
vflInferReq
:
$ref
:
'
#/components/schemas/VflInferReq'
vflReportInfo
:
$ref
:
'
TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
VflInferAnaSub
:
description
:
Represents a subscription to a single event.
type
:
object
properties
:
anaEvent
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
vflCorreId
:
type
:
string
description
:
>
VFL correlation ID used to identify the VFL process to be executed among
the candidate VFL participants to which the VFL inference subscription
procedure relates.
vflEventFilter
:
$ref
:
'
TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventFilter'
required
:
-
anaEvent
-
vflCorreId
VflInferReq
:
description
:
>
Represents the requirement on conditions to be fulfilled for the VFL Inference.
type
:
object
properties
:
timeWindows
:
type
:
array
items
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/TimeWindow'
minItems
:
1
resTime
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DateTime'
VflInferResult
:
description
:
>
Represents intermediate VFL inference result per target UE.
type
:
object
properties
:
vflInferRes
:
type
:
array
items
:
type
:
string
minItems
:
1
required
:
-
vflInferRes
Prev
1
…
3
4
5
6
7
8
9
10
11
…
13
Next