Skip to content
GitLab
Explore
Sign in
Show whitespace changes
Inline
Side-by-side
TS29520_Nnwdaf_VFLTraining.yaml
0 → 100644
View file @
1a359940
openapi
:
3.0.0
info
:
title
:
Nnwdaf_VFLTraining
version
:
1.0.0-alpha.1
description
:
|
Nnwdaf_VFLTraining 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-vfltraining/v1'
variables
:
apiRoot
:
default
:
https://example.com
description
:
apiRoot as defined in clause 4.4 of 3GPP TS
29.501
security
:
-
{}
-
oAuth2ClientCredentials
:
-
nnwdaf-vfltraining
paths
:
/subscriptions
:
post
:
summary
:
Create a new Individual VFL Training Subscription resource.
operationId
:
CreateNWDAFVFLTrainingSubcription
tags
:
-
Subscriptions (Collection)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflTrainingSubs'
responses
:
'
201'
:
description
:
Create a new Individual VFL Training Subscription resource.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflTrainingSubs'
headers
:
Location
:
description
:
>
Contains the URI of the newly created resource, according to the structure
{apiRoot}/nnwdaf-vfltraining/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
:
nwdafVflTrainingNotification
:
'
{$request.body#/notifUri}'
:
post
:
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflTrainingNotify'
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 VFL Training Subscription
operationId
:
UpdateNWDAFVFLTrainingSubcription
tags
:
-
Individual VFL Training Subscription (Document)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflTrainingSubs'
parameters
:
-
name
:
subscriptionId
in
:
path
description
:
String identifying a subscription to the Nnwdaf_VFLTraining Service.
required
:
true
schema
:
type
:
string
responses
:
'
200'
:
description
:
>
The Individual VFL Training Subscription resource was modified successfully and a
representation of that resource is returned.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/VflTrainingSubs'
'
204'
:
description
:
>
The Individual VFL Training 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'
delete
:
summary
:
Delete an existing Individual VFL Training Subscription.
operationId
:
DeleteNWDAFVFLTrainingSubcription
tags
:
-
Individual VFL Training Subscription (Document)
parameters
:
-
name
:
subscriptionId
in
:
path
description
:
String identifying a subscription to the Nnwdaf_VFLTraining Service.
required
:
true
schema
:
type
:
string
responses
:
'
204'
:
description
:
>
No Content. The Individual VFL Training 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-vfltraining
:
Access to the Nnwdaf_VFLTraining API
schemas
:
VflTrainingSubs
:
description
:
Represents VFL Training subscription.
type
:
object
properties
:
notifUri
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uri'
notifCorrId
:
type
:
string
description
:
Notification correlation identifier.
vflTrainSub
:
type
:
array
items
:
$ref
:
'
#/components/schemas/VflTrainingSub'
minItems
:
1
eventReq
:
$ref
:
'
TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
notifUri
-
notifCorrId
-
vflTrainSub
VflTrainingSub
:
description
:
Represents VFL Training subscription for a analytics ID.
type
:
object
properties
:
event
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
vflCorrId
:
type
:
string
description
:
Represents the VFL Correlation ID.
interopInfo
:
$ref
:
'
#/components/schemas/VflInteropInfo'
maxRspTime
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
trainFilter
:
$ref
:
'
TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventFilter'
intermediateInfo
:
$ref
:
'
#/components/schemas/VflIntermedTrainInfo'
chkFlg
:
type
:
boolean
description
:
>
Set to "true" to indicate that the ML model accuracy monitoring information is
requested.The default value is "false" if omitted.
sampIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Supi'
minItems
:
1
description
:
Represents the initial sample list provided by the VFL server.
selectedSampIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Supi'
minItems
:
1
description
:
Represents the samples which are selected from the initial sample list.
chkPoint
:
$ref
:
'
#/components/schemas/VflCheckpointInfo'
vflFeatIds
:
type
:
array
items
:
type
:
string
minItems
:
1
minNumSamples
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
timeWindows
:
type
:
array
items
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/TimeWindow'
minItems
:
1
required
:
-
event
-
vflCorrId
VflCheckpointInfo
:
description
:
Represents VFL Training check point information.
type
:
object
properties
:
saveCheckpoint
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DateTime'
resRoundInd
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
oneOf
:
-
required
:
[
saveCheckpoint
]
-
required
:
[
resRoundInd
]
VflInteropInfo
:
description
:
Represents VFL interoperability information.
type
:
object
properties
:
interopInfo
:
type
:
array
items
:
type
:
string
minItems
:
1
required
:
-
interopInfo
VflTrainingNotify
:
description
:
Represents a ML Model Training notification.
type
:
object
properties
:
notifCorrId
:
type
:
string
description
:
Notification correlation identifier.
intermediateInfo
:
$ref
:
'
#/components/schemas/VflIntermedTrainInfo'
modelMetric
:
$ref
:
'
TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelMetric'
accMlModel
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
required
:
-
notifCorrId
VflIntermedTrainInfo
:
description
:
Represents the intermediate model training information.
type
:
object
properties
:
intermedTrainInfo
:
type
:
array
items
:
type
:
string
minItems
:
1
required
:
-
intermedTrainInfo
TS29521_Nbsf_Management.yaml
View file @
1a359940
openapi
:
3.0.0
info
:
version
:
1.5.0-alpha.
1
version
:
1.5.0-alpha.
2
title
:
Nbsf_Management
description
:
|
Binding Support Management Service API.
© 202
4
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 202
5
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.521 V19.
0
.0; 5G System; Binding Support Management Service.
description
:
3GPP TS 29.521 V19.
3
.0; 5G System; Binding Support Management Service.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.521/'
servers
:
...
...
TS29522_AIoT.yaml
0 → 100644
View file @
1a359940
openapi
:
3.0.0
info
:
title
:
3gpp-aiot
version
:
1.0.0-alpha.1
description
:
|
API for UE Address service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.522 V19.3.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
-
{}
-
oAuth2ClientCredentials
:
[]
servers
:
-
url
:
'
{apiRoot}/3gpp-aiot/v1'
variables
:
apiRoot
:
default
:
https://example.com
description
:
apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
paths
:
/request-inv
:
post
:
summary
:
Request to perform an AIoT inventory operation.
operationId
:
InventoryRequest
tags
:
-
AIoT Inventory Request (custom operation without associated resources)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/InventoryReq'
responses
:
'
200'
:
description
:
>
OK. The AIoT inventory request is successfully received and processed, and the requested
AIoT inventory related information is returned in the response body.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/InventoryResp'
'
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'
callbacks
:
AIoTOperationsNotif
:
'
{$request.body#/notifUri}'
:
post
:
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/AIoTNotif'
responses
:
'
204'
:
description
:
>
No Content. The AIoT Operations 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'
/request-cmd
:
post
:
summary
:
Request to perform an AIoT command operation.
operationId
:
CommandRequest
tags
:
-
AIoT Command Request (custom operation without associated resources)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/CommandReq'
responses
:
'
200'
:
description
:
>
OK. The AIoT command request is successfully received and processed, and the requested
AIoT command related information is returned in the response body.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/CommandResp'
'
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'
callbacks
:
AIoTOperationsNotif
:
'
{$request.body#/notifUri}'
:
post
:
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/AIoTNotif'
responses
:
'
204'
:
description
:
>
No Content. The AIoT Operations 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'
components
:
securitySchemes
:
oAuth2ClientCredentials
:
type
:
oauth2
flows
:
clientCredentials
:
tokenUrl
:
'
{tokenUrl}'
scopes
:
{}
schemas
:
#
# STRUCTURED DATA TYPES
#
InventoryReq
:
description
:
Represents the AIoT inventory request.
type
:
object
properties
:
afId
:
type
:
string
targetArea
:
$ref
:
'
#/components/schemas/ExtAIoTArea'
targetDevices
:
$ref
:
'
TS29569_Naiotf_AIoT.yaml#/components/schemas/AIoTDevices'
numDevices
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
notifUri
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
afId
-
notifUri
anyOf
:
-
required
:
[
targetArea
]
-
required
:
[
targetDevices
]
InventoryResp
:
description
:
Represents the AIoT inventory response.
type
:
object
properties
:
afTransId
:
type
:
string
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
afTransId
CommandReq
:
description
:
Represents the AIoT command request.
type
:
object
properties
:
afId
:
type
:
string
commandType
:
$ref
:
'
#/components/schemas/CommandType'
targetArea
:
$ref
:
'
#/components/schemas/ExtAIoTArea'
targetDevices
:
$ref
:
'
TS29569_Naiotf_AIoT.yaml#/components/schemas/AIoTDevices'
numDevices
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
msgSize
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
notifUri
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
afId
-
commandType
-
notifUri
anyOf
:
-
required
:
[
targetArea
]
-
required
:
[
targetDevices
]
CommandResp
:
description
:
Represents the AIoT command response.
type
:
object
properties
:
afTransId
:
type
:
string
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
afTransId
AIoTNotif
:
description
:
Represents the AIoT Operations Notification.
type
:
object
properties
:
afTransId
:
type
:
string
devices
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
minItems
:
1
lastRepInd
:
type
:
boolean
default
:
false
description
:
>
Contains the Last Report Indication, i.e., indicates whether this is the last reporting
from the NF service consumer.
true indicates that this is the last report.
false indicates that this is not the last report.
The default value is false when this attribute is omitted.
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
afTransId
ExtAIoTArea
:
description
:
Represents the AIoT area.
type
:
object
properties
:
areaIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/AiotAreaId'
minItems
:
1
geographicAreas
:
type
:
array
items
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
minItems
:
1
civicAddresses
:
type
:
array
items
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress'
minItems
:
1
oneOf
:
-
required
:
[
areaIds
]
-
required
:
[
geographicAreas
]
-
required
:
[
civicAddresses
]
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#
CommandType
:
anyOf
:
-
type
:
string
enum
:
-
READ
-
WRITE
-
PERMANENT_DISABLE
-
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 AIoT command.
Possible values are:
- READ: Indicates that the AIoT command is Read (i.e., retrieve information).
- WRITE: Indicates that the AIoT command is Write (i.e., provision information).
- PERMANENT_DISABLE: Indicates that the AIoT command is Permanent Disable (i.e., disable
the capability to transmit information).
#
# Data types describing alternative data types or combinations of data types
#
TS29522_AMInfluence.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
AMInfluence
version
:
1.2.0-alpha.
1
version
:
1.2.0-alpha.
2
description
:
|
AMInfluence API Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/
servers
:
...
...
@@ -377,8 +377,8 @@ components:
description
:
Identifies geographic areas of the user where the request is applicable.
policyDuration
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DurationSec'
sliceReplReq
s
:
$ref
:
'
TS29522_AMPolicyAuthorization.yaml#/components/schemas/SliceReplReq'
sliceReplReq
Info
:
$ref
:
'
TS29522_AMPolicyAuthorization.yaml#/components/schemas/SliceReplReq
Info
'
self
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Link'
subscribedEvents
:
...
...
@@ -403,7 +403,7 @@ components:
anyOf
:
-
required
:
[
highThruInd
]
-
required
:
[
geoAreas
]
-
required
:
[
sliceReplReq
]
-
required
:
[
sliceReplReq
Info
]
oneOf
:
-
required
:
[
gpsi
]
-
required
:
[
externalGroupId
]
...
...
@@ -427,8 +427,8 @@ components:
nullable
:
true
policyDuration
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DurationSecRm'
sliceReplReq
s
:
$ref
:
'
TS29522_AMPolicyAuthorization.yaml
#/components/schemas/SliceReplReq'
sliceReplReq
Info
:
$ref
:
'
#/components/schemas/SliceReplReq
InfoRm
'
dnnSnssaiInfos
:
type
:
array
items
:
...
...
@@ -468,7 +468,7 @@ components:
minItems
:
1
description
:
Identifies geographic areas of the user where the request is applicable.
sliceReplOut
:
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/SliceReplOutcome'
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/SliceReplOutcome
Info
'
required
:
-
event
-
afTransId
...
...
@@ -482,6 +482,25 @@ components:
snssai
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Snssai'
SliceReplReqInfoRm
:
description
:
>
Represents the same as the SliceReplReqInfo data type 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'
afServId
:
type
:
string
altAfServId
:
type
:
string
nullable
:
true
oneOf
:
-
required
:
[
snssai
,
altSnssai
]
-
required
:
[
afServId
,
altAfServId
]
# ENUMERATIONS DATA TYPES
#
AmInfluEvent
:
...
...
@@ -495,7 +514,9 @@ components:
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 NEF notification event to the
NF service consumer
.
Represents the NEF notification event to the
AF
.
Possible values are:
- SERVICE_AREA_COVRG_OUTCOME: Indicates the Service Area Coverage outcome.
- SLICE_REPLACE_OUTCOME: Indicates the AF requested Network Slice replacement outcome.
- SERVICE_AREA_COVRG_OUTCOME: Indicates that the AM Influence event is the Service Area
Coverage outcome.
- SLICE_REPLACE_OUTCOME: Indicates the AM Influence event is the notification of the AF
requested Network Slice Replacement outcome.
TS29522_AMPolicyAuthorization.yaml
View file @
1a359940
openapi
:
3.0.0
info
:
title
:
3gpp-am-policyauthorization
version
:
1.2.0-alpha.
1
version
:
1.2.0-alpha.
2
description
:
|
API for AM policy authorization.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
-
{}
...
...
@@ -475,7 +475,7 @@ components:
nullable
:
true
policyDuration
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DurationSecRm'
slice
Se
lReq
:
slice
Rep
lReq
:
$ref
:
'
#/components/schemas/SliceReplReq'
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
...
...
@@ -491,7 +491,7 @@ components:
anyOf
:
-
required
:
[
highThruInd
]
-
required
:
[
covReqs
]
-
required
:
[
slice
Se
lReq
]
-
required
:
[
slice
Rep
lReq
]
AppAmContextExpUpdateData
:
description
:
>
...
...
@@ -509,8 +509,8 @@ components:
$ref
:
'
#/components/schemas/GeographicalArea'
minItems
:
1
policyDuration
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DurationSec'
slice
Se
lReq
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DurationSec
Rm
'
slice
Rep
lReq
:
$ref
:
'
#/components/schemas/SliceReplReq'
GeographicalArea
:
...
...
@@ -530,8 +530,9 @@ components:
-
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AppAmContextData'
-
$ref
:
'
TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/AmEventsNotification'
SliceReplReq
:
description
:
Represents the AF requested Network Slice replacement information.
SliceReplReqInfo
:
description
:
>
Represents the AF requested Network Slice Replacement requirements information.
type
:
object
properties
:
snssai
:
...
...
@@ -545,3 +546,39 @@ components:
oneOf
:
-
required
:
[
snssai
,
altSnssai
]
-
required
:
[
afServId
,
altAfServId
]
SliceReplReq
:
description
:
>
Represents the requested Network Slice Replacement requirements.
type
:
object
properties
:
type
:
$ref
:
'
#/components/schemas/SliceReplType'
afSliceReplReq
:
$ref
:
'
#/components/schemas/SliceReplReqInfo'
required
:
-
type
#
# ENUMERATIONS
#
SliceReplType
:
anyOf
:
-
type
:
string
enum
:
-
INITIATE_AF_REQ_SLICE_REP
-
TERMINATE_AF_REQ_SLICE_REP
-
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 type of the requested Network Slice Replacement.
Possible values are:
- INITIATE_AF_REQ_SLICE_REP: Indicates that the type of the requested Network Slice
Replacement is the initiation of an AF requested Network Slice Replacement.
- TERMINATE_AF_REQ_SLICE_REP: Indicates that the type of the requested Network Slice
Replacement is the termination of a previously requested Network Slice Replacement from
the AF.
TS29522_AnalyticsExposure.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-analyticsexposure
version
:
1.3.0-alpha.
2
version
:
1.3.0-alpha.
3
description
:
|
API for Analytics Exposure.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
...
...
@@ -40,7 +40,7 @@ paths:
type
:
string
-
name
:
supp-feat
in
:
query
description
:
Features supported by the NF service consumer
description
:
Contains the list of supported features.
required
:
false
schema
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
...
...
@@ -196,7 +196,7 @@ paths:
type
:
string
-
name
:
supp-feat
in
:
query
description
:
Features supported by the NF service consumer
description
:
Contains the list of supported features.
required
:
false
schema
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
...
...
@@ -691,6 +691,16 @@ components:
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/BitRate'
minItems
:
1
e2eDelayThds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PacketDelBudget'
minItems
:
1
deviations
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
minItems
:
1
disperReqs
:
type
:
array
items
:
...
...
@@ -792,6 +802,16 @@ components:
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/SignalStormReq'
minItems
:
1
nfInstanceIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems
:
1
nfSetIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfSetId'
minItems
:
1
TargetUeId
:
description
:
Represents the target UE(s) information.
...
...
@@ -966,6 +986,11 @@ components:
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerformanceReq'
minItems
:
1
disperReqs
:
type
:
array
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DispersionRequirement'
minItems
:
1
maxNumOfTopAppUl
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
maxNumOfTopAppDl
:
...
...
@@ -1018,6 +1043,16 @@ components:
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/SignalStormReq'
minItems
:
1
nfInstanceIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems
:
1
nfSetIds
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/NfSetId'
minItems
:
1
AnalyticsData
:
description
:
Represents analytics data.
...
...
@@ -1064,11 +1099,6 @@ components:
items
:
$ref
:
'
#/components/schemas/QosSustainabilityExposure'
minItems
:
1
disperInfos
:
type
:
array
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DispersionInfo'
minItems
:
1
dnPerfInfos
:
type
:
array
items
:
...
...
@@ -1235,6 +1265,8 @@ components:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/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,7 +1389,7 @@ components:
- UNAVAILABLE_DATA: The event is rejected since necessary data to perform the service
is unavailable.
- BOTH_STAT_PRED_NOT_ALLOWED: The event is rejected since the start time is in the past
and the end time is in the future, which means the
NF service consumer
requested both
and the end time is in the future, which means the
AF
requested both
statistics and prediction for the analytics.
- UNSATISFIED_REQUESTED_ANALYTICS_TIME: Indicates that the requested event is rejected
since the analytics information is not ready when the time indicated by the timeAnaNeeded
...
...
TS29522_DataReporting.yaml
View file @
1a359940
openapi
:
3.0.0
info
:
title
:
3gpp-data-reporting
version
:
1.
1
.0
version
:
1.
2
.0
-alpha.1
description
:
|
API for 3GPP Data Reporting.
© 202
4
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 202
5
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
>
3GPP TS 29.522 V1
8.6
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V1
9.3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
...
...
TS29522_EASDeployment.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-eas-deployment
version
:
1.2.0-alpha.
2
version
:
1.2.0-alpha.
3
description
:
|
API for AF provisioned EAS Deployment.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
...
...
@@ -298,27 +298,27 @@ paths:
description
:
>
No Content. The EDIs matching the provided criteria have been successfully deleted.
'
400'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/400'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/401'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/403'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/404'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/411'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/413'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/415'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/429'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/500'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/500'
'
503'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/503'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/default'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/default'
components
:
securitySchemes
:
...
...
TS29522_ImsEventExposure.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-ims-ee
version
:
1.0.0-alpha.
2
version
:
1.0.0-alpha.
3
description
:
|
API for IMS Event Exposure Services.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
servers
:
...
...
@@ -29,7 +29,7 @@ paths:
parameters
:
-
name
:
afId
in
:
path
description
:
Represents the identifier of the AF
description
:
Represents the identifier of the AF
.
required
:
true
schema
:
type
:
string
...
...
@@ -138,7 +138,7 @@ paths:
responses
:
'
204'
:
description
:
>
No Content. The IMS EE
n
otification is successfully received and acknowledged.
No Content. The IMS EE
N
otification is successfully received and acknowledged.
'
307'
:
$ref
:
'
TS29122_CommonData.yaml#/components/responses/307'
'
308'
:
...
...
@@ -282,7 +282,7 @@ paths:
content
:
application/merge-patch+json
:
schema
:
$ref
:
'
#/components/schemas/I
MS
EESubscPatch'
$ref
:
'
#/components/schemas/I
ms
EESubscPatch'
responses
:
'
200'
:
description
:
>
...
...
@@ -370,7 +370,7 @@ components:
#
ImsEESubsc
:
description
:
Represents an IMS E
E
Subscription.
description
:
Represents an IMS E
vent Exposure
Subscription.
type
:
object
properties
:
eventReqs
:
...
...
@@ -378,6 +378,13 @@ components:
items
:
$ref
:
'
#/components/schemas/ImsEventRequirement'
minItems
:
1
imsReptReq
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ImsReportingOptions'
immReports
:
type
:
array
items
:
$ref
:
'
#/components/schemas/ImsEventReport'
minItems
:
1
tgtUeIds
:
type
:
array
items
:
...
...
@@ -396,11 +403,21 @@ components:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
required
:
-
eventReqs
-
imsReptReq
-
notifUri
oneOf
:
-
required
:
[
tgtUeIds
]
-
required
:
[
anyUeInd
]
I
MS
EESubscPatch
:
description
:
Represents the requested modifications to an IMS E
E
Subscription.
I
ms
EESubscPatch
:
description
:
Represents the requested modifications to an IMS E
vent Exposure
Subscription.
type
:
object
properties
:
eventReqs
:
type
:
array
items
:
$ref
:
'
#/components/schemas/ImsEventRequirement'
minItems
:
1
notifUri
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
...
...
@@ -410,6 +427,8 @@ components:
properties
:
subscriptionId
:
type
:
string
sessionId
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SessionId'
reports
:
type
:
array
items
:
...
...
@@ -423,40 +442,30 @@ components:
-
reports
ImsEventRequirement
:
description
:
Represnets the IMS Event Requirement.
description
:
Represnets the IMS Event Requirement
s
.
type
:
object
properties
:
stndImsEvent
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ImsEvent'
nonStndImsEvent
:
description
:
Indicates the requested non-standardized IMS event.
type
:
string
imsEventType
:
$ref
:
'
#/components/schemas/ImsEventType'
imsEventConfig
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ImsEventConfiguration'
required
:
-
imsEventType
oneOf
:
-
required
:
[
stndImsEvent
]
-
required
:
[
nonStndImsEvent
]
-
imsEventConfig
ImsEventReport
:
description
:
Represents an IMS Event Report.
type
:
object
properties
:
stndI
msEvent
:
i
msEvent
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ImsEvent'
nonStndImsEvent
:
type
:
string
description
:
Indicates the non-standardized IMS event within the requested scope.
timeStamp
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DateTime'
eventRptInfo
:
type
:
string
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/ImsEventReportInfo'
required
:
-
imsEvent
-
timeStamp
oneOf
:
-
required
:
[
stndImsEvent
]
-
required
:
[
nonStndImsEvent
]
#
...
...
@@ -480,6 +489,7 @@ components:
description
:
|
Represents the IMS Event Type.
Possible values are:
- SUBSCRIBER_SPECIFIC: Indicates the IMS Event is Subscriber Specific for data channel.
- NON_SUBSCRIBER_SPECIFIC: Indicates the IMS Event is Subscriber Specific for data
- SUBSCRIBER_SPECIFIC: Indicates that the IMS Event type is Subscriber Specific for data
channel.
- NON_SUBSCRIBER_SPECIFIC: Indicates that the IMS Event type is Subscriber Specific for
Data channel.
TS29522_ImsParamProvision.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-ims-pp
version
:
1.0.0-alpha.
1
version
:
1.0.0-alpha.
2
description
:
|
API for IMS Parameters Provisioning.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
...
...
TS29522_ImsSessionManagement.yaml
0 → 100644
View file @
1a359940
openapi
:
3.0.0
info
:
title
:
3gpp-ims-sm
version
:
1.0.0-alpha.1
description
:
|
API for IMS Session Management.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
>
3GPP TS 29.522 V19.3.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
-
{}
-
oAuth2ClientCredentials
:
[]
servers
:
-
url
:
'
{apiRoot}/3gpp-ims-sm/v1'
variables
:
apiRoot
:
default
:
https://example.com
description
:
apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
paths
:
/ims-sessions
:
get
:
summary
:
Request to retrieve all the active IMS Sessions managed by the NEF.
operationId
:
GetImsSessions
tags
:
-
IMS Sessions (Collection)
responses
:
'
200'
:
description
:
>
OK. All the active IMS Sessions resources managed by the NEF are returned.
content
:
application/json
:
schema
:
type
:
array
items
:
$ref
:
'
#/components/schemas/ImsSession'
minItems
:
0
'
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'
post
:
summary
:
Request to create a new IMS Session resource.
tags
:
-
IMS Session Creation (Collection)
operationId
:
CreateImsSession
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/ImsSession'
responses
:
'
201'
:
description
:
>
Created. Successful creation of a new Individual IMS Session resource.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/ImsSession'
headers
:
Location
:
description
:
>
Contains the URI of the newly created resource, according to the structure
{apiRoot}/3gpp-ims-sm/v1/ims-sessions/{sessionId}
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'
'
409'
:
$ref
:
'
TS29122_CommonData.yaml#/components/responses/409'
'
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
:
ImsSessionNotif
:
'
{$request.body#/notifUri}'
:
post
:
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
TS29175_Nimsas_ImsSessionManagement.yaml#/components/schemas/ImsSessionEventNotification'
responses
:
'
204'
:
description
:
>
No Content. The IMS EE 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'
/ims-sessions/{sessionId}
:
parameters
:
-
name
:
sessionId
in
:
path
description
:
>
Represents the identifier of the Individual IMS Session resource.
required
:
true
schema
:
type
:
string
get
:
summary
:
Retrieve an existing Individual IMS Session resource.
operationId
:
GetIndImsSession
tags
:
-
Individual IMS Session (Document)
responses
:
'
200'
:
description
:
>
OK. The requested "Individual IMS Session" resource is successfully returned in the
response body.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/ImsSession'
'
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
:
Update an existing Individual IMS Session resource.
operationId
:
UpdateIndImsSession
tags
:
-
Individual IMS Session (Document)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/ImsSession'
responses
:
'
200'
:
description
:
>
OK. The Individual IMS Session resource is successfully updated and a representation
of the updated resource is returned in the response body.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/ImsSession'
'
204'
:
description
:
>
No Content. The Individual IMS Session Management 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'
'
409'
:
$ref
:
'
TS29122_CommonData.yaml#/components/responses/409'
'
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 IMS Session resource.
operationId
:
DeleteIndImsSession
tags
:
-
Individual IMS Session (Document)
responses
:
'
204'
:
description
:
>
No Content. The Individual IMS Session 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'
'
409'
:
$ref
:
'
TS29122_CommonData.yaml#/components/responses/409'
'
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
#
ImsSession
:
description
:
Represents the IMS Session Information.
type
:
object
properties
:
afId
:
type
:
string
imsSessionInfo
:
$ref
:
'
TS29175_Nimsas_ImsSessionManagement.yaml#/components/schemas/ImsSessionInfo'
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
afId
-
imsSessionInfo
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#
TS29522_MBSSession.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-mbs-session
version
:
1.3.0-alpha.
1
version
:
1.3.0-alpha.
2
description
:
|
API for MBS Session Management.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
servers
:
...
...
TS29522_MSEventExposure.yaml
View file @
1a359940
...
...
@@ -2,15 +2,15 @@ openapi: 3.0.0
info
:
title
:
3gpp-ms-event-exposure
version
:
1.
1
.0
version
:
1.
2
.0
-alpha.1
description
:
|
API for Media Streaming Event Exposure.
© 202
4
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 202
5
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
>
3GPP TS 29.522 V1
8.6
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V1
9.3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
servers
:
...
...
TS29522_MemberUESelectionAssistance.yaml
View file @
1a359940
...
...
@@ -2,15 +2,15 @@ openapi: 3.0.0
info
:
title
:
3gpp-musa
version
:
1.
0
.0
version
:
1.
1
.0
-alpha.1
description
:
|
API for Member UE Selection Assistance.
© 202
4
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 202
5
, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
>
3GPP TS 29.522 V1
8.6
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V1
9.3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
servers
:
...
...
TS29522_ServiceParameter.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-service-parameter
version
:
1.3.0-alpha.
2
version
:
1.3.0-alpha.
3
description
:
|
API for AF service paramter
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
...
...
@@ -770,6 +770,8 @@ components:
description
:
Contains parameters that can be used to guide the URSP.
type
:
object
properties
:
afReqUrspId
:
type
:
string
trafficDesc
:
$ref
:
'
#/components/schemas/TrafficDescriptorComponents'
relatPrecedence
:
...
...
@@ -852,6 +854,8 @@ components:
oneOf
:
-
required
:
[
qosReference
]
-
required
:
[
indQosParamSet
]
not
:
required
:
[
flowInfos
,
ethFlowInfos
]
Event
:
anyOf
:
...
...
@@ -859,6 +863,7 @@ components:
enum
:
-
SUCCESS_UE_POL_DEL_SP
-
UNSUCCESS_UE_POL_DEL_SP
-
PARTLY_UNSUCC_UE_POL_DEL_SP
-
UNSUCCESS_PCF_SERVICE_AUTHORIZATION
-
type
:
string
description
:
>
...
...
@@ -872,6 +877,8 @@ components:
the invocation of AF provisioned Service Parameters.
- UNSUCCESS_UE_POL_DEL_SP: Unsuccessful UE Policy Delivery related to the invocation of AF
provisioned Service Parameters.
- PARTLY_UNSUCC_UE_POL_DEL_SP: Partially unsuccessful UE Policy Delivery related to the
invocation of AF provisioned Service Parameters.
- UNSUCCESS_PCF SERVICE AUTHORIZATION: Unsuccessful authorization in the PCF related to the
invocation of AF provisioned Service Parameters.
...
...
@@ -899,6 +906,15 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Snssai'
eventInfo
:
$ref
:
'
#/components/schemas/EventInfo'
detEventInfo
:
type
:
object
additionalProperties
:
$ref
:
'
#/components/schemas/DetailedEventInfo'
minProperties
:
1
description
:
>
Detailed outcome of the AF service parameter request. The key of the map is the
attribute "gpsi". It is only applicable if the "reportEvent" attribute has the value
"PARTLY_UNSUCC_UE_POL_DEL_SP".
required
:
-
subscription
anyOf
:
...
...
@@ -1031,6 +1047,44 @@ components:
plmnId
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/PlmnIdNid'
DetailedEventInfo
:
description
:
>
Detailed information about the delivery outcome of service parameter provisioning requests.
type
:
object
properties
:
uePolEventInfos
:
type
:
array
items
:
$ref
:
'
#/components/schemas/UePolEventInfo'
minItems
:
1
description
:
contains the UE policy event information.
gpsi
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Gpsi'
required
:
-
uePolEventInfos
-
gpsi
UePolEventInfo
:
description
:
>
Event information about the outcome of Service Parameter provisioning requests for the UE
policy delivery.
type
:
object
properties
:
policyType
:
$ref
:
'
#/components/schemas/UePolPartType'
outcome
:
$ref
:
'
#/components/schemas/Outcome'
afReqUrspIds
:
type
:
array
items
:
type
:
string
minItems
:
1
description
:
>
Contains the Unsuccessfully delivery URSP rule Ids that related to the AF provided
Service parameter provisioning.
required
:
-
policyType
Failure
:
anyOf
:
-
type
:
string
...
...
@@ -1111,3 +1165,41 @@ components:
- TIME_CRITICAL: Indicates the connection capability to support time critical services.
- LOW_LAT_LOSS_TOL_UNACK: Indicates the connection capability to support low latency
loss tolerant communications in un-acknowledged mode.
UePolPartType
:
anyOf
:
-
type
:
string
enum
:
-
URSP
-
V2XP
-
A2XP
-
PROSEP
-
RSLPP
-
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 a UE policy part type.
Possible values are:
- URSP: Represents a URSP UE policy part type.
- V2XP: Represents a V2X UE policy part type.
- A2XP: Represents a A2X UE policy part type.
- PROSEP: Represents a ProSe UE policy part type.
- RSLPP: Represents a RSLPP UE policy part type.
Outcome
:
anyOf
:
-
type
:
string
enum
:
-
REJECTED_BY_UE
-
NOT_AUTHORIZED_BY_PCF
-
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 detailed outcome of the requests for AF provisioned service parameters.
Possible values are:
- REJECTED_BY_UE: The requested parameters were not successfully installed on the UE.
- NOT_AUTHORIZED_BY_PCF: The requested parameters were not authorized by the PCF.
TS29522_TimeSyncExposure.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-time-sync
version
:
1.2.0-alpha.
3
version
:
1.2.0-alpha.
4
description
:
|
API for time synchronization exposure.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
...
...
@@ -692,7 +692,7 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Snssai'
subsNotifId
:
type
:
string
description
:
Notification Correlation ID assigned by the
NF service consumer
.
description
:
Notification Correlation ID assigned by the
AF
.
subsNotifUri
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
subscribedEvents
:
...
...
@@ -783,7 +783,7 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
configNotifId
:
type
:
string
description
:
Notification Correlation ID assigned by the
NF service consumer
.
description
:
Notification Correlation ID assigned by the
AF
.
configNotifUri
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
tempValidity
:
...
...
@@ -807,7 +807,7 @@ components:
properties
:
subsNotifId
:
type
:
string
description
:
Notification Correlation ID assigned by the
NF service consumer
.
description
:
Notification Correlation ID assigned by the
AF
.
eventNotifs
:
type
:
array
items
:
...
...
@@ -841,7 +841,7 @@ components:
properties
:
configNotifId
:
type
:
string
description
:
Notification Correlation ID assigned by the
NF service consumer
.
description
:
Notification Correlation ID assigned by the
AF
.
stateOfConfig
:
$ref
:
'
#/components/schemas/StateOfConfiguration'
required
:
...
...
@@ -990,7 +990,7 @@ components:
When the PTP port state is Leader, Follower or Passive, it is included and set to true
to indicate the state of configuration for DS-TT port is active; when PTP port state is
in any other case, it is included and set to false to indicate the state of
configuration for DS port is inactive.
Default value is false.
configuration for DS port is inactive.
clkQltIndOfDstt
:
$ref
:
'
#/components/schemas/AcceptanceCriteriaResultIndication'
required
:
...
...
TS29522_TrafficInfluence.yaml
View file @
1a359940
...
...
@@ -2,7 +2,7 @@ openapi: 3.0.0
info
:
title
:
3gpp-traffic-influence
version
:
1.4.0-alpha.
2
version
:
1.4.0-alpha.
3
description
:
|
API for AF traffic influence
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,7 +10,7 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
...
...
@@ -580,9 +580,12 @@ components:
candDnaiInd
:
type
:
boolean
description
:
>
Indication of reporting candidate DNAI(s). If it is included and set to "true", the
candidate DNAI(s) for the PDU session need to be reported. Otherwise set to "false" or
omitted.
Indicates whether the reporting of the candidate DNAI(s) is requested.
true indicates that the reporting of the candidate DNAI(s) is requested for the PDU
session.
false indicates that the reporting of the candidate DNAI(s) is not requested for the PDU
session.
The default value is false if this attribute is omitted.
tfcCorreInfo
:
$ref
:
'
TS29519_Application_Data.yaml#/components/schemas/TrafficCorrelationInfo'
plmnId
:
...
...
@@ -761,10 +764,16 @@ components:
candDnaisPrioInd
:
type
:
boolean
description
:
>
If provided and set to true, it indicates that the candidate DNAIs provided
in the candidateDnais attribute are in descending priority order, i.e.,
the lower the array index the higher the priority of the respective DNAI.
If omitted, the default value is false.
Indicates whether the candidate DNAI(s) provided within the candidateDnais attribute are
in descending priority order, i.e., the lower the array index of the candidateDnais
attribute the higher the priority of the respective DNAI.
true indicates that the candidate DNAI(s) provided within the candidateDnais attribute
are in descending priority order.
false indicates that the candidate DNAI(s) provided within the candidateDnais attribute
are not in descending priority order.
The default value is false if this attribute is omitted.
This attribute may only be present if the candidateDnais attribute is also present and
the dnaiChgType attribute is set to the value "EARLY".
easRediscoverInd
:
type
:
boolean
description
:
>
...
...
@@ -795,9 +804,6 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
subscribedEvent
oneOf
:
-
required
:
[
dnaiChgType
]
-
required
:
[
traffRouteReqOutcome
]
AfResultInfo
:
description
:
Identifies the result of application layer handling.
...
...
@@ -915,6 +921,7 @@ components:
enum
:
-
UP_PATH_CHANGE
-
TRAFF_ROUTE_REQ_OUTCOME
-
SIM_CONN_FAIL
-
type
:
string
description
:
>
This string provides forward-compatibility with future extensions to the enumeration but
...
...
@@ -926,6 +933,8 @@ components:
the PDU session.
- TRAFF_ROUTE_REQ_OUTCOME: The AF requests to be notified of the installation outcome of
the traffic routing requirements requested by the AF.
- SIM_CONN_FAIL: The AF requests to be notified if the requested Simultaneous Connectivity
over the source and the target PDU Session Anchor fails.
AfResultStatus
:
anyOf
:
...
...
TS29522_UAVFlightAssistance.yaml
View file @
1a359940
openapi
:
3.0.0
info
:
title
:
3gpp-uav-f
light-assistance
version
:
1.0.0-alpha.
2
title
:
3gpp-uav-f
a
version
:
1.0.0-alpha.
3
description
:
|
API for UAV Flight Assistance.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...
...
@@ -10,11 +10,11 @@ info:
externalDocs
:
description
:
>
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/
servers
:
-
url
:
'
{apiRoot}/3gpp-uav-f
light-assistance
/v1'
-
url
:
'
{apiRoot}/3gpp-uav-f
a
/v1'
variables
:
apiRoot
:
default
:
https://example.com
...
...
@@ -254,35 +254,31 @@ paths:
No Content. The Individual UAV Flight Assistance Configuration resource is successfully
updated and no content is returned in the response body.
'
307'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/307'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/308'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/400'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/401'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/403'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/404'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/404'
'
411'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/411'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/411'
'
413'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/413'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/413'
'
415'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/415'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/415'
'
429'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/429'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
501'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/501'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
$ref
:
'
TS29122_CommonData.yaml#/components/responses/500'
'
503'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/503'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/default'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/default'
patch
:
summary
:
Request the modification of an existing Individual UAV Flight Assistance Configuration resource.
...
...
@@ -290,9 +286,6 @@ paths:
-
Individual Group Parameters Provisioning (Document)
operationId
:
ModifyIndUavFlightAssistConfig
requestBody
:
description
:
>
Contains the parameters to request the modification of the Individual UAV Flight
Assistance Configuration resource.
required
:
true
content
:
application/merge-patch+json
:
...
...
@@ -349,29 +342,82 @@ paths:
No Content. The Individual UAV Flight Assistance Configuration resource is successfully
deleted.
'
307'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/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'
/{afId}/retrieve
:
parameters
:
-
name
:
afId
in
:
path
description
:
Represents the identifier of the AF.
required
:
true
schema
:
type
:
string
post
:
summary
:
Request to retrieve UAV flight information.
operationId
:
RetrieveUAVFlightInfo
tags
:
-
Retrieve (custom operation without associated resources)
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/UAVFlightInfoReq'
responses
:
'
200'
:
description
:
>
OK. The UAV Flight information retrieval request is successfully processed, and the
the requested UAV Flight information is returned in the response body.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/UAVFlightInfoResp'
'
307'
:
$ref
:
'
TS29122_CommonData.yaml#/components/responses/307'
'
308'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/308'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/308'
'
400'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/400'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/400'
'
401'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/401'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/401'
'
403'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/403'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/403'
'
404'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/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
:
'
TS29
571
_CommonData.yaml#/components/responses/429'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/429'
'
500'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/500'
'
501'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/501'
'
502'
:
$ref
:
'
TS29571_CommonData.yaml#/components/responses/502'
$ref
:
'
TS29122_CommonData.yaml#/components/responses/500'
'
503'
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/503'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/503'
default
:
$ref
:
'
TS29
571
_CommonData.yaml#/components/responses/default'
$ref
:
'
TS29
122
_CommonData.yaml#/components/responses/default'
components
:
...
...
@@ -398,16 +444,38 @@ components:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Gpsi'
reqPurpose
:
$ref
:
'
#/components/schemas/RequestPurpose'
monitorMode
:
$ref
:
'
#/components/schemas/MonitoringMode'
environUavs
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Gpsi'
minItems
:
1
preSetDistance
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/LinearDistance'
qosSustReq
:
$ref
:
'
TS29522_AnalyticsExposure.yaml#/components/schemas/AnalyticsEventFilter'
notifUri
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
flightPath
:
$ref
:
'
#/components/schemas/FlightPath'
alt
Reports
:
alt
itudeRep
:
type
:
array
items
:
$ref
:
'
#/components/schemas/AltitudeReport'
minItems
:
1
description
:
Indicates the UAV altitude report.
altitudeRepReqs
:
$ref
:
'
#/components/schemas/AltitudeRepReqs'
stopAltRepInd
:
type
:
boolean
enum
:
-
true
description
:
>
Indicates whether to stop the altitude reporting for the UAV UE. Set to true indicates
to stop the altitude reporting for the UAV UE.
When present, this attribute shall be set to true. The presence of this attribute set to
the value false is forbidden.
This attribute may be present only in the PUT request.
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
...
...
@@ -433,6 +501,13 @@ components:
properties
:
flightSeg
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
ussId
:
type
:
string
candBdCrsPoints
:
type
:
array
items
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
minItems
:
1
uavSpeed
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Float'
altitude
:
...
...
@@ -443,23 +518,50 @@ components:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DurationSec'
required
:
-
flightSeg
-
ussId
not
:
required
:
[
timeSchedule
,
timeDuration
]
UAVFlightAssistNotif
:
description
:
Notify the UAV status
.
description
:
Represents the UAV Flight Assistance Notification
.
type
:
object
properties
:
subscriptionId
:
type
:
string
uavStatus
:
$ref
:
'
#/components/schemas/UavStatus'
b
order
Point
:
b
dCrs
Point
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
altitude
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
altReportReqs
:
$ref
:
'
#/components/schemas/AltReportReqs'
altitudeRptInd
:
type
:
boolean
enum
:
-
true
uavLocation
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
uavTrajectInd
:
type
:
boolean
description
:
>
Indicates whether the UAV is following the assigned path/trajectory.
- "true" indicates that the UAV is following the assigned path/trajectory.
- "false" indicates that UAV is not following the assign path/trajectory.
uavPresList
:
type
:
array
items
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Gpsi'
minItems
:
1
rangSlUavDatas
:
type
:
array
items
:
$ref
:
'
#/components/schemas/RangSlUavData'
minItems
:
1
qosSustainInfos
:
type
:
array
items
:
$ref
:
'
TS29522_AnalyticsExposure.yaml#/components/schemas/QosSustainabilityExposure'
altitudeRepReqs
:
$ref
:
'
#/components/schemas/AltitudeRepReqs'
required
:
-
subscriptionId
-
uavStatus
...
...
@@ -471,9 +573,10 @@ components:
ussChgInd
:
type
:
boolean
description
:
>
This attribute is used to indicate whether the USS changeover is completed successfully.
true indicates that USS changeover is completed
successfully; false (default): USS changeover failed.
This attribute is used to indicate whether the USS changeover was completed
successfully.
true indicates that USS changeover was successful.
false indicates that USS changeover failed.
required
:
-
ussChgInd
...
...
@@ -485,17 +588,40 @@ components:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/Uri'
flightPath
:
$ref
:
'
#/components/schemas/FlightPath'
altitudeRep
:
type
:
array
items
:
$ref
:
'
#/components/schemas/AltitudeReport'
minItems
:
1
altitudeRepReqs
:
$ref
:
'
#/components/schemas/AltitudeRepReqs'
stopAltRepInd
:
type
:
boolean
enum
:
-
true
description
:
>
Indicates whether to stop the altitude reporting for the UAV UE. Set to true indicates
to stop the altitude reporting for the UAV UE.
When present, this attribute shall be set to true. The presence of this attribute set to
the value false is forbidden.
AltRep
ort
Reqs
:
description
:
Represents the UAV altitude reporting requirements.
Alt
itude
RepReqs
:
description
:
Represents the UAV
's
altitude reporting requirements.
type
:
object
properties
:
altThreshold
:
$ref
:
'
#/components/schemas/AltRange'
altReportPeriod
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/DurationSec'
altReportEvent
:
$ref
:
'
#/components/schemas/AltReportEvent'
repThresholds
:
$ref
:
'
#/components/schemas/AltThresholds'
repPeriodicity
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
repEvents
:
type
:
array
items
:
$ref
:
'
#/components/schemas/AltitudeRepEvent'
minItems
:
1
oneOf
:
-
required
:
[
repThresholds
]
-
required
:
[
repPeriodicity
]
-
required
:
[
repEvents
]
AltitudeReport
:
description
:
Represents the UAV altitude report.
...
...
@@ -503,17 +629,96 @@ components:
properties
:
altitude
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
event
:
$ref
:
'
#/components/schemas/AltitudeRepEvent'
timeStamp
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DateTime'
required
:
-
altitude
Alt
Range
:
Alt
Thresholds
:
description
:
Represents the UAV altitude range for reporting.
type
:
object
properties
:
lowerBound
:
$ref
:
'
TS2957
1_CommonData
.yaml#/components/schemas/
Uinteger
'
$ref
:
'
TS2957
2_Nlmf_Location
.yaml#/components/schemas/
Altitude
'
upperBound
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
anyOf
:
-
required
:
[
lowerBound
]
-
required
:
[
upperBound
]
RangSlUavData
:
description
:
Represents the Ranging Slidelink UAV data.
type
:
object
properties
:
uavId
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Gpsi'
presetDistInd
:
type
:
boolean
description
:
>
Indicates whether the Ranging/Sidelink distance to the target UAV is small than the
preset distance value.
- "true" indicates that the distance is smaller than the preset distance value.
- "false" indicates that the distance is not smaller than the preset distance value.
rangSlDistance
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/LinearDistance'
required
:
-
uavId
anyOf
:
-
required
:
[
presetDistInd
]
-
required
:
[
rangSlDistance
]
UAVFlightInfoReq
:
description
:
Represents the UAF Flight information retrieval request.
type
:
object
properties
:
gpsi
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Gpsi'
retrievePurpose
:
$ref
:
'
#/components/schemas/RetrievePurpose'
targetUssList
:
type
:
array
items
:
type
:
string
minItems
:
1
canFltPathsInfo
:
type
:
array
items
:
$ref
:
'
#/components/schemas/CandidateFlightPathInfo'
minItems
:
1
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
gpsi
-
retrievePurpose
CandidateFlightPathInfo
:
description
:
Represents the candidate flight path information.
type
:
object
properties
:
borderCrssPnt
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
accptDeviatDist
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/Uinteger'
accptDeviatTime
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/DurationSec'
canFlightPath
:
$ref
:
'
#/components/schemas/FlightPath'
UAVFlightInfoResp
:
description
:
Represents the UAF Flight information retrieval response.
type
:
object
properties
:
retrievedResults
:
type
:
array
items
:
$ref
:
'
#/components/schemas/UAVFlightAssistNotif'
minItems
:
1
suppFeat
:
$ref
:
'
TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required
:
-
retrievedResults
#
# ENUMERATIONS
...
...
@@ -543,7 +748,6 @@ components:
-
type
:
string
enum
:
-
USS_CHANGEOVER
-
PRE_FLIGHT_PLANNING
-
IN_FLIGHT_MONITORING
-
type
:
string
description
:
>
...
...
@@ -553,21 +757,60 @@ components:
Represents the UAV Flight Assitance request purpose.
Possible values are:
- USS_CHANGEOVER: Indicates that the purpose of the request is pre-flight planning.
- PRE_FLIGHT_PLANNING: Indicates that the purpose of the request is USS changeover.
- IN_FLIGHT_MONITORING:Indicates that the purpose of the request is in-flight monitoring.
AltRep
ort
Event
:
Alt
itude
RepEvent
:
anyOf
:
-
type
:
string
enum
:
-
TA_CHANGE
-
RAN_NODE_CHANGE
-
GEO_LOCATION_CHANGE
-
ANY_ALTITUDE_CHANGE
-
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 altitude reporting event.
Possible values are:
- TA_CHANGE: Indicates that the UAV's altitude reporting trigger is the change of the UAV's
serving TA.
- RAN_NODE_CHANGE: Indicates that the UAV's altitude reporting trigger is the change of the
UAV's serving RAN node.
- GEO_LOCATION_CHANGE: Indicates that the UAV's altitude reporting trigger is the change of
the UAV's geographical location.
- ANY_ALTITUDE_CHANGE: Indicates that the UAV's altitude reporting trigger is any change of
the UAV's altitude.
MonitoringMode
:
anyOf
:
-
type
:
string
enum
:
-
UAV_LOCATION_MONITORING
-
FLIGHT_TRAJECTORY_MONITORING
-
FLIGHT_ENVIRONMENT_MONITORING
-
RANGING_SIDELINK_POSITION_MONITORING
-
QOS_SUSTAINABILITY_ANALYTICS
-
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.
RetrievePurpose
:
anyOf
:
-
type
:
string
enum
:
-
USS_CHANGEOVER
-
PRE_FLIGHT_PLANNING
-
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
Altitude reporting events
.
Represents the
purpose of the retrieved UAV flight information
.
Possible values are:
- TA_CHANGE: Indicates the change of UAV’s serving TA.
- RAN_NODE_CHANGE: Indicates the change of UAV’s serving RAN node.
- USS_CHANGEOVER: Indicates that the purpose of the UAV Flight information retrieval is
USS changeover.
- PRE_FLIGHT_PLANNING: Indicates that the purpose of the UAV Flight information retrieval
is pre-flight planning.
TS29522_UEAddress.yaml
View file @
1a359940
...
...
@@ -2,14 +2,14 @@ openapi: 3.0.0
info
:
title
:
3gpp-ue-address
version
:
1.1.0-alpha.
2
version
:
1.1.0-alpha.
3
description
:
|
API for UE Address service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
3GPP TS 29.522 V19.
2
.0; 5G System; Network Exposure Function Northbound APIs.
description
:
3GPP TS 29.522 V19.
3
.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security
:
-
{}
...
...
@@ -382,12 +382,12 @@ components:
description
:
Represents the UE Address Notification.
type
:
object
properties
:
notif
Corr
Id
:
notifId
:
type
:
string
uePubAddrInfo
:
$ref
:
'
TS29564_Nupf_EventExposure.yaml#/components/schemas/UeNatMappingInfo'
required
:
-
notif
Corr
Id
-
notifId
-
uePubAddrInfo
...
...
TS29522_VFLNFDiscovery.yaml
0 → 100644
View file @
1a359940
openapi
:
3.0.0
info
:
title
:
3gpp-vfl-nf-discovery
version
:
1.0.0-alpha.1
description
:
|
API for VFL NF Discovery.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs
:
description
:
>
3GPP TS 29.522 V19.3.0; 5G System; Network Exposure Function Northbound APIs.
url
:
'
https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
servers
:
-
url
:
'
{apiRoot}/3gpp-vfl-nf-discovery/v1'
variables
:
apiRoot
:
default
:
https://example.com
description
:
apiRoot as defined in clause 4.4 of 3GPP TS
29.501
security
:
-
{}
-
oAuth2ClientCredentials
:
[]
paths
:
/discover-nwdaf
:
post
:
summary
:
Request of NWDAF(s) that are to act as VFL client(s).
tags
:
-
VFL NF discovery
operationId
:
DiscoverNwdaf
requestBody
:
description
:
Representation of the request of NWDAF that are to act as VFL client(s).
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/NwdafDiscoveryRequest'
responses
:
'
200'
:
description
:
>
OK. Successful case. The external NWDAF ID is provisioned.
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/NwdafDiscoveryResponse'
'
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'
/release-nwdaf
:
post
:
summary
:
Request to inform the external NWDAF ID(s) are not used anymore.
operationId
:
ReleaseNwdaf
tags
:
-
VFL NF discovery release
requestBody
:
required
:
true
content
:
application/json
:
schema
:
$ref
:
'
#/components/schemas/NwdafReleaseRequest'
responses
:
'
204'
:
description
:
No Content. Successful case.
'
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
:
type
:
oauth2
flows
:
clientCredentials
:
tokenUrl
:
'
{tokenUrl}'
scopes
:
{}
schemas
:
NwdafDiscoveryRequest
:
description
:
>
Represents the parameters to request the NWDAF(s) that are to act as VFL client(s).
type
:
object
properties
:
analyticIds
:
type
:
array
items
:
$ref
:
'
TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent'
minItems
:
1
vflInterInfo
:
type
:
string
description
:
String representing the VFL Interoperability Information.
reqFeatureIds
:
type
:
array
items
:
type
:
string
minItems
:
1
timePeriod
:
$ref
:
'
TS29122_CommonData.yaml#/components/schemas/TimeWindow'
serviceAreas
:
type
:
array
items
:
$ref
:
'
TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
minItems
:
1
required
:
-
analyticIds
NwdafDiscoveryResponse
:
description
:
>
Represents the external NWDAF ID(s) to act as the VFL client(s).
type
:
object
properties
:
exNwdafIds
:
type
:
array
items
:
type
:
string
description
:
The current external NWDAF identifier.
minItems
:
1
required
:
-
exNwdafIds
NwdafReleaseRequest
:
description
:
>
Represents the parameters to inform the external NWDAF ID(s) are not used anymore.
type
:
object
properties
:
exNwdafIds
:
type
:
array
items
:
type
:
string
description
:
The current external NWDAF identifier.
minItems
:
1
required
:
-
exNwdafIds
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#
VFLCapabilityType
:
anyOf
:
-
type
:
string
enum
:
-
VFL_CLIENT
-
type
:
string
description
:
Represents the VFL capability type to be discovered.
description
:
|
Represents the VFL capability type to be discovered.
Possible values are:
- VFL_CLIENT: Represents the VFL capability type to be discovered is VFL client.
Prev
1
…
4
5
6
7
8
9
10
11
12
13
Next