Skip to content
Show whitespace changes
Inline Side-by-side
TS29564_Nupf_EventExposure.yaml
View file @ eee1c11e
...@@ -2,14 +2,14 @@ openapi: 3.0.0 ...@@ -2,14 +2,14 @@ openapi: 3.0.0
info: info:
title: 'UPF Event Exposure Service' title: 'UPF Event Exposure Service'
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
description: | description: |
UPF Event Exposure Service. UPF Event Exposure Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.564 V19.2.0; 5G System; User Plane Function Services; Stage 3. description: 3GPP TS 29.564 V19.3.0; 5G System; User Plane Function Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/
servers: servers:
...@@ -394,8 +394,6 @@ components: ...@@ -394,8 +394,6 @@ components:
type: boolean type: boolean
enum: enum:
- true - true
remainingDataReports:
$ref: '#/components/schemas/RemainingDataReports'
required: required:
- trigger - trigger
...@@ -435,6 +433,8 @@ components: ...@@ -435,6 +433,8 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16' $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint16'
ipDomain: ipDomain:
type: string type: string
remainingDataReports:
$ref: '#/components/schemas/RemainingDataReports'
required: required:
- type - type
...@@ -508,6 +508,11 @@ components: ...@@ -508,6 +508,11 @@ components:
defaultQosFlowInd: defaultQosFlowInd:
type: boolean type: boolean
default: false default: false
dlAvailableBitrate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
ulAvailableBitrate:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
TscManagementInfo: TscManagementInfo:
......
TS29564_Nupf_GetUEPrivateIPaddrAndIdentifiers.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.0.0' version: '1.1.0-alpha.1'
title: 'UPF GET UE Private IP address and Identifiers Service' title: 'UPF GET UE Private IP address and Identifiers Service'
description: | description: |
Nupf_GetUEPrivateIPaddrAndIdentifiers Service. Nupf_GetUEPrivateIPaddrAndIdentifiers Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.564 V18.5.0; 5G System; 5G System; User Plane Function Services; Stage 3 description: 3GPP TS 29.564 V19.3.0; 5G System; 5G System; User Plane Function Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.564/'
servers: servers:
......
TS29565_Ntsctsf_QoSandTSCAssistance.yaml
View file @ eee1c11e
...@@ -2,7 +2,7 @@ openapi: 3.0.0 ...@@ -2,7 +2,7 @@ openapi: 3.0.0
info: info:
title: Ntsctsf_QoSandTSCAssistance Service API title: Ntsctsf_QoSandTSCAssistance Service API
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
description: | description: |
TSCTSF QoS and TSC Assistance Service. TSCTSF QoS and TSC Assistance Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
...@@ -10,7 +10,7 @@ info: ...@@ -10,7 +10,7 @@ info:
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.565 V19.2.0; 5G System; Time Sensitive Communication and Time Synchronization function 3GPP TS 29.565 V19.3.0; 5G System; Time Sensitive Communication and Time Synchronization function
Services; Stage 3. Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/'
...@@ -738,6 +738,11 @@ components: ...@@ -738,6 +738,11 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
qosMon: qosMon:
$ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformation' $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformation'
capTypes:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/NotifCapType'
minItems: 1
usgThres: usgThres:
$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold'
notifCorreId: notifCorreId:
...@@ -760,6 +765,11 @@ components: ...@@ -760,6 +765,11 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
qosMon: qosMon:
$ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformationRm' $ref: 'TS29122_AsSessionWithQoS.yaml#/components/schemas/QosMonitoringInformationRm'
capTypes:
type: array
items:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/NotifCapType'
minItems: 1
usgThres: usgThres:
$ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm'
notifCorreId: notifCorreId:
...@@ -816,8 +826,11 @@ components: ...@@ -816,8 +826,11 @@ components:
event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION. event QOS_NOT_GUARANTEED or SUCCESSFUL_RESOURCES_ALLOCATION.
batOffsetInfo: batOffsetInfo:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo' $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/BatOffsetInfo'
qosMonCapRepo: qosMonCapRepos:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/NotifCap' type: object
additionalProperties:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/CapabilityReport'
minProperties: 1
AdditionalInfoTsctsfQosTscac: AdditionalInfoTsctsfQosTscac:
description: Describes additional error information specific for this API. description: Describes additional error information specific for this API.
......
TS29565_Ntsctsf_TimeSynchronization.yaml
View file @ eee1c11e
...@@ -2,15 +2,15 @@ openapi: 3.0.0 ...@@ -2,15 +2,15 @@ openapi: 3.0.0
info: info:
title: Ntsctsf_TimeSynchronization Service API title: Ntsctsf_TimeSynchronization Service API
version: 1.2.0-alpha.1 version: 1.2.0-alpha.2
description: | description: |
TSCTSF Time Synchronization Service. TSCTSF Time Synchronization Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: > description: >
3GPP TS 29.565 V19.1.0; 5G System; Time Sensitive Communication and Time Synchronization Function 3GPP TS 29.565 V19.3.0; 5G System; Time Sensitive Communication and Time Synchronization Function
Services; Stage 3. Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.565/'
servers: servers:
...@@ -736,7 +736,7 @@ components: ...@@ -736,7 +736,7 @@ components:
When the PTP port state is Leader, Follower or Passive, it is included and set to true 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 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 in any other case, it is included and set to false to indicate the state of
configuration for DS-TT port is inactive. Default value is false. configuration for DS-TT port is inactive.
clkQltIndOfDstt: clkQltIndOfDstt:
$ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/AcceptanceCriteriaResultIndication' $ref: 'TS29522_TimeSyncExposure.yaml#/components/schemas/AcceptanceCriteriaResultIndication'
required: required:
......
TS29569_Naiotf_AIoT.yaml 0 → 100644
View file @ eee1c11e
openapi: 3.0.0
info:
title: Naiotf_AIoT Service API
version: 1.0.0-alpha.3
description: |
API for_AIoT Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.569 V1.0.0; Ambient IoT Function (AIOTF) Services.
url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.569/
servers:
- url: '{apiRoot}/naiotf-aiot/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
security:
- {}
- oAuth2ClientCredentials:
- naiotf-aiot
paths:
/request-inv:
post:
summary: Request to perform an AIoT inventory operation.
operationId: InventoryRequest
tags:
- AIoT Inventory Request (custom operation without associated resources)
security:
- {}
- oAuth2ClientCredentials:
- naiotf-aiot
- oAuth2ClientCredentials:
- naiotf-aiot
- naiotf-aiot:inventory
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: '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:
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: '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'
/request-cmd:
post:
summary: Request to perform an AIoT command operation.
operationId: CommandRequest
tags:
- AIoT Command Request (custom operation without associated resources)
security:
- {}
- oAuth2ClientCredentials:
- naiotf-aiot
- oAuth2ClientCredentials:
- naiotf-aiot
- naiotf-aiot:command
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: '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:
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: '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:
naiotf-aiot: >
Enables to access all the resources and custom operations of the Naiotf_AIoT API.
naiotf-aiot:inventory: >
Enables to access only the InventoryRequest custom operation (Naiotf_AIoT_Inventory
service operation) of the Naiotf_AIoT API.
naiotf-aiot:command: >
Enables to access only the CommandRequest custom operation (Naiotf_AIoT_Command
service operation) of the Naiotf_AIoT API.
schemas:
#
# STRUCTURED DATA TYPES
#
InventoryReq:
description: Represents the AIoT inventory request.
type: object
properties:
afId:
type: string
targetArea:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotArea'
targetDevices:
$ref: '#/components/schemas/AIoTDevices'
numDevices:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
notifUri:
$ref: 'TS29571_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:
transId:
type: string
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- transId
CommandReq:
description: Represents the AIoT command request.
type: object
properties:
afId:
type: string
commandType:
$ref: 'TS29522_AIoT.yaml#/components/schemas/CommandType'
targetArea:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotArea'
targetDevices:
$ref: '#/components/schemas/AIoTDevices'
numDevices:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
msgSize:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
notifUri:
$ref: 'TS29571_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:
transId:
type: string
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- transId
AIoTNotif:
description: Represents the AIoT Operations Notification.
type: object
properties:
transId:
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:
- transId
AIoTDevices:
description: Represents the AIoT device(s) related information.
type: object
properties:
devices:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotDevPermId'
minItems: 1
filteringInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AiotFilteringInformation'
anyOf:
- required: [devices]
- required: [filteringInfo]
#
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#
#
# Data types describing alternative data types or combinations of data types
#
TS29570_Nscp_EventExposure.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
title: Nscp_EventExposure title: Nscp_EventExposure
version: 1.0.0-alpha.1 version: 1.0.0-alpha.4
description: | description: |
SCP Event Exposure Service. SCP Event Exposure Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.570 V0.1.0; Service Communication Proxy Services. description: 3GPP TS 29.570 V1.0.0; Service Communication Proxy Services.
url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.570/ url: http://www.3gpp.org/ftp/Specs/archive/29_series/29.570/
servers: servers:
- url: '{apiRoot}/nscp-ee/v1' - url: '{apiRoot}/nscp-ee/v1'
...@@ -46,7 +46,7 @@ paths: ...@@ -46,7 +46,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ScpEventExposureSubscription' $ref: '#/components/schemas/ScpEventExposureSubsResp'
'307': '307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307' $ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308': '308':
...@@ -78,7 +78,7 @@ paths: ...@@ -78,7 +78,7 @@ paths:
default: default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default' $ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks: callbacks:
onScpEventExposureSubscriptionNotification: onScpEventExposureNotification:
'{$request.body#/subscription/notificationUri}': '{$request.body#/subscription/notificationUri}':
post: post:
summary: SCP Event Exposure Notification summary: SCP Event Exposure Notification
...@@ -239,7 +239,179 @@ components: ...@@ -239,7 +239,179 @@ components:
ScpEventExposureSubscription: ScpEventExposureSubscription:
description: Describes an event to be subscribed description: Describes an event to be subscribed
type: object type: object
properties:
eventList:
type: array
items:
$ref: '#/components/schemas/ScpEventFilter'
minItems: 1
eventNotifyUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
notifyCorrelationId:
type: string
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required:
- eventList
- eventNotifyUri
- notifyCorrelationId
ScpEventFilter:
description: Describes an SCP event
type: object
properties:
eventType:
$ref: '#/components/schemas/ScpEventType'
timeWindow:
$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/RecurTime'
filterConfigs:
type: array
items:
$ref: '#/components/schemas/ScpEventFilterConfig'
minItems: 1
required:
- eventType
ScpEventFilterConfig:
description: Describes an SCP event filters
type: object
properties:
targetNfSetId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
targetNfIdList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
minItems: 1
serviceNameList:
type: array
items:
$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName'
minItems: 1
serviceInstanceIdList:
type: array
items:
type: string
minItems: 1
reportingThreshold:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
devFromAveTh:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
failureTh:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
ScpEventType:
description: Describes the supported event types of Nscp_EventExposure Service
anyOf:
- type: string
enum:
- SERVICE_SIGNALLING_CHARACTERISTICS
- type: string
ScpEventExposureNotification: ScpEventExposureNotification:
description: Represents an event notification description: Represents an event notification
type: object type: object
properties:
notifyCorrelationId:
type: string
reportList:
type: array
items:
$ref: '#/components/schemas/ScpEventReport'
minItems: 1
ScpEventExposureSubsResp:
description: Represents SCP Event Exposure Subscription Response
type: object
properties:
expiryTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
ScpEventReport:
description: Describes an SCP report triggered due to a subscription to an SCP event
type: object
properties:
eventType:
$ref: '#/components/schemas/ScpEventType'
timeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
nfId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nfSetId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId'
aveIngress:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
aveEgress:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
egressSuccessRate:
type: integer
egressFailRate:
type: integer
failureCauseStat:
type: array
items:
$ref: '#/components/schemas/FailureCauseOccurrence'
priority:
type: integer
capacity:
type: integer
load:
type: integer
signalingStat:
type: array
items:
$ref: '#/components/schemas/ScpSigTypeStat'
# ueId attribute data type is FFS and depends on the clarification from SA2.
# heartBeatInfo attribute data type is FFS and depends on the clarification from SA2.
required:
- eventType
- timeStamp
FailureCauseOccurrence:
description: The number of times that a failure happened due to a particular cause
type: object
properties:
cause:
$ref: '#/components/schemas/FailureCause'
number:
type: integer
required:
- cause
- number
ScpSigTypeStat:
description: The number a types of signalling received or sent by SCP
type: object
properties:
signalType:
type: string
number:
type: integer
required:
- signalType
- number
#
# ENUMERATIONS
#
FailureCause:
description: Describes the reasons for failed responses related to SCP egress interface
anyOf:
- type: string
enum:
- TIME_OUT
- SERVER_ERROR
- CONSUMER_ERROR
- OTHER_FAILURE_REASONS
- type: string
TS29571_CommonData.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.6.0-alpha.3' version: '1.6.0-alpha.4'
title: 'Common Data Types' title: 'Common Data Types'
...@@ -11,7 +11,7 @@ info: ...@@ -11,7 +11,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 19.2.0 description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 19.3.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/'
paths: {} paths: {}
...@@ -1144,7 +1144,7 @@ components: ...@@ -1144,7 +1144,7 @@ components:
format: uuid format: uuid
description: > description: >
String uniquely identifying a NF instance. The format of the NF Instance ID shall be a String uniquely identifying a NF instance. The format of the NF Instance ID shall be a
Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122. Universally Unique Identifier (UUID) version 4.
AmfId: AmfId:
type: string type: string
...@@ -1629,6 +1629,10 @@ components: ...@@ -1629,6 +1629,10 @@ components:
description: > description: >
Unique identifier of a satellite. Unique identifier of a satellite.
EnergySavingIndicator:
$ref: '#/components/schemas/Uinteger'
# #
# ENUMERATED DATA TYPES # ENUMERATED DATA TYPES
# #
...@@ -4542,6 +4546,7 @@ components: ...@@ -4542,6 +4546,7 @@ components:
- type: string - type: string
enum: enum:
- PDU_SET_MARKING - PDU_SET_MARKING
- DYN_CHANGING_TRAFFIC_CHAR
- type: string - type: string
description: > description: >
The enumeration indicates the type of Rtp Header Extension type The enumeration indicates the type of Rtp Header Extension type
...@@ -4574,6 +4579,24 @@ components: ...@@ -4574,6 +4579,24 @@ components:
This data type is defined in the same way as the 'RtpPayloadFormat' data type, but with the This data type is defined in the same way as the 'RtpPayloadFormat' data type, but with the
OpenAPI 'nullable: true' property. OpenAPI 'nullable: true' property.
MriTransferMethod:
anyOf:
- type: string
enum:
- UDP_OPTION
- type: string
description: >
This data type indicates the method used for transferring Media Related Information.
MriTransferMethodRm:
anyOf:
- $ref: '#/components/schemas/MriTransferMethod'
- $ref: '#/components/schemas/NullValue'
description: >
This data type is defined in the same way as the 'MriTransferMethod' data type,
but with the OpenAPI 'nullable: true' property.
# #
# #
# STRUCTURED DATA TYPES # STRUCTURED DATA TYPES
...@@ -4729,11 +4752,18 @@ components: ...@@ -4729,11 +4752,18 @@ components:
$ref: '#/components/schemas/MediaTransportProto' $ref: '#/components/schemas/MediaTransportProto'
rtpHeaderExtInfo: rtpHeaderExtInfo:
$ref: '#/components/schemas/RtpHeaderExtInfo' $ref: '#/components/schemas/RtpHeaderExtInfo'
addRtpHeaderExtInfo:
type: array
items:
$ref: '#/components/schemas/RtpHeaderExtInfo'
minItems: 1
rtpPayloadInfoList: rtpPayloadInfoList:
type: array type: array
items: items:
$ref: '#/components/schemas/RtpPayloadInfo' $ref: '#/components/schemas/RtpPayloadInfo'
minItems: 1 minItems: 1
mriTransferInfo:
$ref: '#/components/schemas/MriTransferMethod'
ProtocolDescriptionRm: ProtocolDescriptionRm:
description: Describes the modifications to the ProtocolDescription data type. description: Describes the modifications to the ProtocolDescription data type.
...@@ -4750,6 +4780,8 @@ components: ...@@ -4750,6 +4780,8 @@ components:
items: items:
$ref: '#/components/schemas/RtpPayloadInfo' $ref: '#/components/schemas/RtpPayloadInfo'
minItems: 1 minItems: 1
mriTransferInfo:
$ref: '#/components/schemas/MriTransferMethodRm'
RtpHeaderExtInfo: RtpHeaderExtInfo:
...@@ -4799,7 +4831,7 @@ components: ...@@ -4799,7 +4831,7 @@ components:
type: array type: array
items: items:
type: integer type: integer
minimum: 1 minimum: 0
maximum: 127 maximum: 127
minItems: 1 minItems: 1
rtpPayloadFormat: rtpPayloadFormat:
...@@ -4815,7 +4847,7 @@ components: ...@@ -4815,7 +4847,7 @@ components:
nullable: true nullable: true
items: items:
type: integer type: integer
minimum: 1 minimum: 0
maximum: 127 maximum: 127
minItems: 1 minItems: 1
rtpPayloadFormat: rtpPayloadFormat:
...@@ -4829,6 +4861,21 @@ components: ...@@ -4829,6 +4861,21 @@ components:
This enumeration is defined in the same way as the 'PduSetHandlingInfo' enumeration, This enumeration is defined in the same way as the 'PduSetHandlingInfo' enumeration,
but with the OpenAPI 'nullable: true' property. but with the OpenAPI 'nullable: true' property.
MriTransferInfo:
description: Describes how media related information is transferred
type: object
properties:
transferMethod:
$ref: '#/components/schemas/MriTransferMethod'
MriTransferInfoRm:
description: Describes how media related information is transferred
type: object
nullable: true
properties:
transferMethod:
$ref: '#/components/schemas/MriTransferMethodRm'
# #
# Data Types related to 5G Trace as defined in clause 5.6 # Data Types related to 5G Trace as defined in clause 5.6
...@@ -6715,7 +6762,6 @@ components: ...@@ -6715,7 +6762,6 @@ components:
- type: string - type: string
enum: enum:
- DC - DC
- AR
- AUDIO - AUDIO
- VIDEO - VIDEO
- type: string - type: string
...@@ -6727,6 +6773,17 @@ components: ...@@ -6727,6 +6773,17 @@ components:
enum: enum:
- HTTP_PROXY - HTTP_PROXY
- UDP_PROXY - UDP_PROXY
- DC_APPLICATION_PROXY
- type: string
SecuritySetup:
description: security setup of the DTLS connection
anyOf:
- type: string
enum:
- ACTIVE
- PASSIVE
- ACTPASS
- type: string - type: string
BdcUsedBy: BdcUsedBy:
...@@ -6756,19 +6813,60 @@ components: ...@@ -6756,19 +6813,60 @@ components:
- ADC_RELEASE - ADC_RELEASE
- BDC_ESTABLISHMENT - BDC_ESTABLISHMENT
- BDC_RELEASE - BDC_RELEASE
- ADC_INTERWORK_ESTAB - ADC_IWK_ESTABLISHMENT
- type: string - type: string
SecuritySetup: AdcStatus:
description: security setup of the DTLS connection description: ADC event status.
anyOf: anyOf:
- type: string - type: string
enum: enum:
- ACTIVE - ADC_ESTABLISHED
- PASSIVE - ADC_RELEASED
- ACTPASS - ADC_IWK_ESTABLISHED
- 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.
BdcStatus:
description: BDC event status.
anyOf:
- type: string
enum:
- BDC_ESTABLISHED
- BDC_RELEASED
- 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.
ImsReportMode:
description: Ims event report mode.
anyOf:
- type: string
enum:
- ON_EVENT_DETECTION
- PERIODIC
- 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.
RenderingMode:
description: The rendering mode for avatar media
anyOf:
- type: string - type: string
enum:
- UE_CENTRIC
- NET_CENTRIC_MF
- NET_CENTRIC_DCAS
- type: string
# STRUCTURED DATA TYPES # STRUCTURED DATA TYPES
# #
...@@ -6917,6 +7015,374 @@ components: ...@@ -6917,6 +7015,374 @@ components:
securitySetup: securitySetup:
$ref: '#/components/schemas/SecuritySetup' $ref: '#/components/schemas/SecuritySetup'
ImsReportingOptions:
description: Ims event reporting options.
type: object
properties:
reportMode:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsReportMode'
oneTimeReport:
type: boolean
oneTimeNotification:
type: boolean
maxNumOfReports:
type: integer
reportPeriod:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
expiry:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
ImsEventConfiguration:
description: Ims event configuration information.
type: object
required:
- imsEvent
properties:
imsEvent:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEvent'
eventInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/EventInformation'
reqCurrentStatus:
type: boolean
imsEventFilters:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEventFilter'
minItems: 1
EventInformation:
description: Ims event information.
type: object
properties:
adcConfig:
type: string
bdcConfig:
type: string
ImsEventFilter:
description: Conditions to match specific Ims event.
type: object
properties:
callingId:
type: string
pattern: '^(sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|tel\:\+[0-9]{5,15})$'
calledId:
type: string
pattern: '^(sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|tel\:\+[0-9]{5,15})$'
appBindingInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AppBindingInfo'
sessionId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId'
ImsEventReport:
description: Ims event report.
type: object
required:
- imsEvent
properties:
imsEvent:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEvent'
eventReport:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ImsEventReportInfo'
sessionId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SessionId'
ImsEventReportInfo:
description: Ims event report specific information.
type: object
properties:
adcReport:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AdcReport'
bdcReport:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BdcReport'
AdcReport:
description: Application data channel report.
type: object
required:
- adcStatus
properties:
adcStatus:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AdcStatus'
BdcReport:
description: Bootstrap data channel report.
type: object
required:
- bdcStatus
properties:
bdcStatus:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BdcStatus'
RcdProperties:
description: Contains the RCD related parameters.
type: object
properties:
rcdSrvAddr:
$ref: '#/components/schemas/ServerAddressingInfo'
rcdUrl:
$ref: '#/components/schemas/Uri'
rcdInfo:
$ref: '#/components/schemas/RcdInformation'
RcdInformation:
description: >
Contains a collection of RCD properties as specified in draft-ietf-sipcore-callinfo-rcd
and represented as a jCard JSON object.
type: object
required:
- identifProps
properties:
identifProps:
$ref: '#/components/schemas/IdentificationProperties'
delvAddrProps:
$ref: '#/components/schemas/DeliveringAddrProperties'
commsProps:
$ref: '#/components/schemas/CommunicationsProperties'
geogrProps:
$ref: '#/components/schemas/GeographicalProperties'
organProps:
$ref: '#/components/schemas/OrganizationalProperties'
explanProps:
$ref: '#/components/schemas/ExplanatoryProperties'
IdentificationProperties:
description: Represents the identity information of the entity associated with the jCard.
type: object
required:
- fns
properties:
fns:
description: >
Represent the "fn" property which provides a formatted text corresponding to the
name of the object the jCard represents as defined in IETF RFC 6350, section 6.2.1.
type: array
items:
type: string
minItems: 1
nProp:
description: >
Represent the "n" property which provides the components of the name of the object
the jCard represents as defined as defined in IETF RFC 6350, section 6.2.2.
type: string
nickNames:
description: >
Represent the "nickname" property which provides the text corresponding to the
nickname of the object the jCard represents as defined in IETF RFC 6350, section 6.2.3.
type: array
items:
type: string
minItems: 1
photos:
description: >
Represent the "photo" property which provides image or photograph information that
annotates some aspect of the object the jCard represents as defined in
IETF RFC 6350, section 6.2.4.
type: array
items:
$ref: '#/components/schemas/Uri'
minItems: 1
DeliveringAddrProperties:
description: >
Represents the information related to the delivery address of the entity associated with
the jCard.
type: object
properties:
adrs:
description: >
Represent the "adr" property which provides the delivery address of the object the
jCard represents as defined in IETF RFC 6350, section 6.3.1.
type: array
items:
type: string
minItems: 1
CommunicationsProperties:
description: Indicates how to communicate with the entity associated with the jCard.
type: object
properties:
tels:
description: >
Represent the "tel" property which provides the telephone number for the object the
jCard represents as defined in IETF RFC 6350, section 6.4.1.
type: array
items:
type: string
minItems: 1
emails:
description: >
Represent the "email" property which provides the electronic mail address of the
object the jCard represents as defined in IETF RFC 6350, section 6.4.2.
type: array
items:
type: string
minItems: 1
langs:
description: >
Represent the "lang" property which provides the language(s) that may be used for
communicating with the object the jCard represents as defined in IETF RFC 6350,
section 6.4.4.
type: array
items:
type: string
minItems: 1
GeographicalProperties:
description: >
Represents the geographical information associated with the entity associated with
the jCard.
type: object
properties:
tzs:
description: >
Represent the "tz" property which provides the time zone of the object the jCard
represents as defined in IETF RFC 6350, section 6.5.1.
type: array
items:
type: string
minItems: 1
geos:
description: >
Represent the "geo" property which provides the global positioning of the object the
jCard represents as defined in IETF RFC 6350, section 6.5.2.
type: array
items:
$ref: '#/components/schemas/Uri'
minItems: 1
OrganizationalProperties:
description: >
Represents the information associated with characteristics of the organization or
organizational units of the entity associated with the jCard.
type: object
properties:
titles:
description: >
Represent the "title" property which has the intent of providing the position or job
of the object the jCard represents as defined in IETF RFC 6350, section 6.6.1.
type: array
items:
type: string
minItems: 1
roles:
description: >
Represent the "role" property which has the intent of providing the position or job
of the object the jCard represents as defined in IETF RFC 6350, section 6.6.2.
type: array
items:
type: string
minItems: 1
logos:
description: >
Represent the "logo" property which has the intent of specifying a graphic image of
a logo associated with the object the jCard represents as defined in IETF RFC 6350,
section 6.6.3.
type: array
items:
$ref: '#/components/schemas/Uri'
minItems: 1
orgs:
description: >
Represent the "org" property which has the intent of specifying the organizational
name and units of the object the jCard represents as defined in IETF RFC 6350,
section 6.6.4.
type: array
items:
type: string
minItems: 1
ExplanatoryProperties:
description: >
Indicates an additional information such as an application category information or notes
that are specific to the entity associated with the jCard.
type: object
required:
- version
properties:
categories:
description: >
Represent the "categories" property which specifies application category information
about the object the jCard represents as defined in IETF RFC 6350, section 6.7.1.
type: array
items:
type: string
minItems: 1
notes:
description: >
Represent the "note" property which specifies supplemental information or a comment
about the object the jCard represents as defined in IETF RFC 6350, section 6.7.2.
type: array
items:
type: string
minItems: 1
sounds:
description: >
Represent the "sound" property which specifies digital sound content information
that annotates some aspect of the object the jCard represents as defined in
IETF RFC 6350, section 6.7.5.
type: array
items:
$ref: '#/components/schemas/Uri'
minItems: 1
uid:
$ref: '#/components/schemas/Uri'
urls:
description: >
Represent the "url" property which specifies a uniform resource locator associated
with the object the jCard represents as defined in IETF RFC 6350, section 6.7.8.
type: array
items:
$ref: '#/components/schemas/Uri'
minItems: 1
version:
description: >
Represent the "version" property which specifies the version of the vCard
specification used to format this vCard as defined in IETF RFC 6350, section 6.7.9.
type: string
# Data Types related to Ambient IoT as defined in clause 5.12
#
#
# SIMPLE DATA TYPES
#
#
AiotAreaId:
description: Ambient IoT Area identifier.
type: string
AiotFilteringInformation:
description: Ambient IoT Filtering Information.
$ref: '#/components/schemas/Bytes'
AiotDevPermId:
type: string
pattern: '^[A-Fa-f0-9]+$'
description: >
String identifying the AIoT Device Permanent Identifier.
#
# STRUCTURED DATA TYPES
#
AiotArea:
description: Contains a list of AIoT Area ID(s).
type: object
properties:
areaIds:
type: array
items:
$ref: '#/components/schemas/AiotAreaId'
minItems: 1
required:
- areaIds
# #
# HTTP responses # HTTP responses
# #
......
TS29572_Nlmf_Broadcast.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.3.0-alpha.1' version: '1.3.0-alpha.2'
title: 'LMF Broadcast' title: 'LMF Broadcast'
description: | description: |
LMF Broadcast Service. LMF Broadcast Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.572 V19.0.0; 5G System; Location Management Services; Stage 3 description: 3GPP TS 29.572 V19.3.0; 5G System; Location Management Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/'
servers: servers:
......
TS29572_Nlmf_DataExposure.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.0.0-alpha.2 version: 1.0.0-alpha.3
title: Nlmf_DataExposure title: Nlmf_DataExposure
description: | description: |
LMF Data Exposure Service. LMF Data Exposure Service.
...@@ -14,7 +14,7 @@ security: ...@@ -14,7 +14,7 @@ security:
- nlmf-dataexposure - nlmf-dataexposure
externalDocs: externalDocs:
description: 3GPP TS 29.572 V19.2.0; 5G System; Location Management Services; Stage 3 description: 3GPP TS 29.572 V19.3.0; 5G System; Location Management Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/'
servers: servers:
...@@ -38,7 +38,7 @@ paths: ...@@ -38,7 +38,7 @@ paths:
required: true required: true
responses: responses:
'201': '201':
description: Subsription Created description: Subscription Created
headers: headers:
Location: Location:
description: > description: >
...@@ -194,7 +194,7 @@ paths: ...@@ -194,7 +194,7 @@ paths:
type: string type: string
responses: responses:
'204': '204':
description: Subsription deleted successfully description: Subscription deleted successfully
'307': '307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307' $ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308': '308':
...@@ -248,10 +248,21 @@ components: ...@@ -248,10 +248,21 @@ components:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID' $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/CorrelationID'
aoi: aoi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
timeWindow: recurTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/RecurTime'
numOfSamples: numOfSamples:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
dataSources:
type: array
items:
$ref: '#/components/schemas/DataSourceType'
minItems: 1
qualityThreshold:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS'
mlModelId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
expiryTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required: required:
- notificationUri - notificationUri
- notifyCorrelationId - notifyCorrelationId
...@@ -273,8 +284,57 @@ components: ...@@ -273,8 +284,57 @@ components:
LmfDataExposureReport: LmfDataExposureReport:
description: Describes an LMF data collection exposure report description: Describes an LMF data collection exposure report
properties:
samplingDataList:
type: array
items:
$ref: '#/components/schemas/LmfDataExposureSamplingData'
minItems: 1
mlModelId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
cause:
$ref: '#/components/schemas/LmfDataExposureCause'
LmfDataExposureSamplingData:
description: Describes an LMF data collection exposure Sampling Data
properties: properties:
timestamp: timestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
locMeasureData:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocMeasurements'
groundTruth:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationData'
qualityIndicator:
type: number
format: float
minimum: 0
maximum: 1
mlLocEstimate:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationData'
required: required:
- timestamp - timestamp
- locMeasureData
- groundTruth
#
# SIMPLE TYPES
#
#
# ENUMERATIONS
#
DataSourceType:
description: The data source for location measurement data collection.
anyOf:
- type: string
enum:
- NG_RAN
- type: string
LmfDataExposureCause:
description: The cause code for LMF Data Exposure Report.
anyOf:
- type: string
enum:
- NOT_ENOUGH_SAMPLES
- type: string
TS29572_Nlmf_Location.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.4.0-alpha.3' version: '1.4.0-alpha.4'
title: 'LMF Location' title: 'LMF Location'
description: | description: |
LMF Location Service. LMF Location Service.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.572 V19.2.0; 5G System; Location Management Services; Stage 3 description: 3GPP TS 29.572 V19.3.0; 5G System; Location Management Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/'
servers: servers:
...@@ -1478,6 +1478,10 @@ components: ...@@ -1478,6 +1478,10 @@ components:
$ref: '#/components/schemas/LosNlosMeasureInd' $ref: '#/components/schemas/LosNlosMeasureInd'
upCumEvtRptCriteria: upCumEvtRptCriteria:
$ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria'
lcsUppExistInd:
type: boolean
enum:
- true
AddLocationContext: AddLocationContext:
description: Information within Location context(s). description: Information within Location context(s).
...@@ -1486,7 +1490,6 @@ components: ...@@ -1486,7 +1490,6 @@ components:
- ldrType - ldrType
- hgmlcCallBackURI - hgmlcCallBackURI
- ldrReference - ldrReference
- eventReportMessage
properties: properties:
locationQoS: locationQoS:
$ref: '#/components/schemas/LocationQoS' $ref: '#/components/schemas/LocationQoS'
...@@ -1516,6 +1519,10 @@ components: ...@@ -1516,6 +1519,10 @@ components:
$ref: '#/components/schemas/LosNlosMeasureInd' $ref: '#/components/schemas/LosNlosMeasureInd'
upCumEvtRptCriteria: upCumEvtRptCriteria:
$ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria'
lcsUppExistInd:
type: boolean
enum:
- true
EventReportMessage: EventReportMessage:
description: Indicates an event report message. description: Indicates an event report message.
...@@ -1874,8 +1881,6 @@ components: ...@@ -1874,8 +1881,6 @@ components:
properties: properties:
ncgi: ncgi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
ecgi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
tai: tai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
...@@ -2380,6 +2385,7 @@ components: ...@@ -2380,6 +2385,7 @@ components:
- type: string - type: string
enum: enum:
- SUPPLEMENTARY_SERVICES - SUPPLEMENTARY_SERVICES
- DUMMY
- type: string - type: string
ReportedEventType: ReportedEventType:
......
TS29573_JOSEProtectedMessageForwarding.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.3.0' version: '1.4.0-alpha.1'
title: 'JOSE Protected Message Forwarding API' title: 'JOSE Protected Message Forwarding API'
description: | description: |
N32-f Message Forwarding Service. N32-f Message Forwarding Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
servers: servers:
- url: '{apiRoot}/n32f-forward/v1' - url: '{apiRoot}/n32f-forward/v1'
...@@ -14,7 +14,7 @@ servers: ...@@ -14,7 +14,7 @@ servers:
default: https://example.com default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
externalDocs: externalDocs:
description: 3GPP TS 29.573 V18.7.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 description: 3GPP TS 29.573 V19.3.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/
paths: paths:
......
TS29573_N32_Handshake.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.3.2' version: '1.4.0-alpha.1'
title: 'N32 Handshake API' title: 'N32 Handshake API'
description: | description: |
N32-c Handshake Service. N32-c Handshake Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
servers: servers:
- url: '{apiRoot}/n32c-handshake/v1' - url: '{apiRoot}/n32c-handshake/v1'
...@@ -14,7 +14,7 @@ servers: ...@@ -14,7 +14,7 @@ servers:
default: https://example.com default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
externalDocs: externalDocs:
description: 3GPP TS 29.573 V18.9.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 description: 3GPP TS 29.573 V19.3.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/
paths: paths:
......
TS29573_SeppTelescopicFqdnMapping.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: '1.2.0' version: '1.3.0-alpha.1'
title: 'SEPP Telescopic FQDN Mapping API' title: 'SEPP Telescopic FQDN Mapping API'
description: | description: |
SEPP Telescopic FQDN Mapping Service. SEPP Telescopic FQDN Mapping Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
servers: servers:
...@@ -16,7 +16,7 @@ servers: ...@@ -16,7 +16,7 @@ servers:
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
externalDocs: externalDocs:
description: 3GPP TS 29.573 V18.7.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 description: 3GPP TS 29.573 V19.3.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/ url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/
paths: paths:
......
TS29574_Ndccf_ContextManagement.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.2.0-alpha.1 version: 1.2.0-alpha.2
title: Ndccf_ContextManagement title: Ndccf_ContextManagement
description: | description: |
DCCF Context Management Service. DCCF Context Management Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.574 V19.2.0; 5G System; Data Collection Coordination Services; Stage 3. description: 3GPP TS 29.574 V19.3.0; 5G System; Data Collection Coordination Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/'
# #
servers: servers:
...@@ -203,7 +203,7 @@ components: ...@@ -203,7 +203,7 @@ components:
anaSub: anaSub:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription'
dataSub: dataSub:
$ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification' $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription'
nwdafId: nwdafId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nwdafSetId: nwdafSetId:
......
TS29574_Ndccf_DataManagement.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
title: Ndccf_DataManagement title: Ndccf_DataManagement
description: | description: |
DCCF Data Management Service. DCCF Data Management Service.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.574 V19.2.0; 5G System; Data Collection Coordination Services; Stage 3. description: 3GPP TS 29.574 V19.3.0; 5G System; Data Collection Coordination Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/'
# #
servers: servers:
...@@ -806,16 +806,6 @@ components: ...@@ -806,16 +806,6 @@ components:
The default value is false. The default value is false.
delAlert: delAlert:
$ref: '#/components/schemas/DeletionAlert' $ref: '#/components/schemas/DeletionAlert'
termCause:
$ref: '#/components/schemas/TermCause'
pendDataNotifCause:
$ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/PendingNotificationCause'
reUserConsentPurs:
type: array
items:
$ref: '#/components/schemas/DataCollectionPurpose'
minItems: 1
description: The purposes of data collection for which the user consent is revoked.
timeStamp: timeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
# #
...@@ -860,6 +850,16 @@ components: ...@@ -860,6 +850,16 @@ components:
subscription that requested by the DCCF, i.e. no further notifications related to this subscription that requested by the DCCF, i.e. no further notifications related to this
subscription will be provided, apart from sending final report (if available). subscription will be provided, apart from sending final report (if available).
The default value is false. The default value is false.
termCause:
$ref: '#/components/schemas/TermCause'
pendDataNotifCause:
$ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/PendingNotificationCause'
reUserConsentPurs:
type: array
items:
$ref: '#/components/schemas/DataCollectionPurpose'
minItems: 1
description: The purposes of data collection for which the user consent is revoked.
timeStamp: timeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
# #
......
TS29575_Nadrf_DataManagement.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
title: Nadrf_DataManagement title: Nadrf_DataManagement
description: | description: |
ADRF Data Management Service. ADRF Data Management Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.575 V19.2.0; 5G System; Analytics Data Repository Services; Stage 3. description: 3GPP TS 29.575 V19.3.0; 5G System; Analytics Data Repository Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/'
# #
servers: servers:
......
TS29575_Nadrf_MLModelManagement.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.1.0-alpha.2 version: 1.1.0-alpha.3
title: Nadrf_MLModelManagement title: Nadrf_MLModelManagement
description: | description: |
ADRF ML Model Management Service. ADRF ML Model Management Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). © 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.575 V19.1.0; 5G System; Analytics Data Repository Services; Stage 3. description: 3GPP TS 29.575 V19.3.0; 5G System; Analytics Data Repository Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/'
# #
servers: servers:
...@@ -345,6 +345,13 @@ components: ...@@ -345,6 +345,13 @@ components:
$ref: '#/components/schemas/ModelStoreResult' $ref: '#/components/schemas/ModelStoreResult'
suppFeat: suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
modelStoreResults:
type: array
items:
$ref: '#/components/schemas/ModelStoreResult'
minItems: 1
description: Indicates the multiple model storage results.
# #
MLModelInfo: MLModelInfo:
description: Represents informatiom of the ML Model. description: Represents informatiom of the ML Model.
...@@ -440,7 +447,8 @@ components: ...@@ -440,7 +447,8 @@ components:
Possible values are: Possible values are:
- ML_MODEL_DELETED: Indicates that the ML model was deleted in ADRF. - ML_MODEL_DELETED: Indicates that the ML model was deleted in ADRF.
- ML_MODEL_NOT_FOUND: Indicates that the ML model was not found in ADRF. - ML_MODEL_NOT_FOUND: Indicates that the ML model was not found in ADRF.
- ML_MODEL_FOUND_BUT_NOT_DELETED: Indicates that the ML model was found in ADRF but not deleted. - ML_MODEL_FOUND_BUT_NOT_DELETED: Indicates that the ML model was found in ADRF but not
deleted.
# #
StoreResult: StoreResult:
...@@ -450,6 +458,7 @@ components: ...@@ -450,6 +458,7 @@ components:
- ML_MODEL_FILE_STORED_IN_ADRF - ML_MODEL_FILE_STORED_IN_ADRF
- ML_MODEL_FILE_ADDRESS_NOT_FOUND - ML_MODEL_FILE_ADDRESS_NOT_FOUND
- ML_MODEL_FILE_DOWNLOAD_FAILED - ML_MODEL_FILE_DOWNLOAD_FAILED
- RETRIEVAL_ML_MODEL_NOT_ALLOWED
- type: string - type: string
description: > description: >
This string provides forward-compatibility with future This string provides forward-compatibility with future
...@@ -459,5 +468,9 @@ components: ...@@ -459,5 +468,9 @@ components:
Represents the store result type. Represents the store result type.
Possible values are: Possible values are:
- ML_MODEL_FILE_STORED_IN_ADRF: Indicates that the ML model was successfully stored in ADRF. - ML_MODEL_FILE_STORED_IN_ADRF: Indicates that the ML model was successfully stored in ADRF.
- ML_MODEL_FILE_ADDRESS_NOT_FOUND: Indicates that the ML model file address was not found. - ML_MODEL_FILE_ADDRESS_NOT_FOUND: Indicates the failure cause of ML model storage is
- ML_MODEL_FILE_DOWNLOAD_FAILED: Indicates that the download of the ML model file failed. because the ML model file address was not found.
- ML_MODEL_FILE_DOWNLOAD_FAILED: Indicates the failure cause of ML model storage is
because the download of the ML model file failed.
- RETRIEVAL_ML_MODEL_NOT_ALLOWED: Indicates the failure cause of ML model retrieval is
because the retrieval of the ML model is not allowed.
TS29576_Nmfaf_3caDataManagement.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
title: Nmfaf_3caDataManagement title: Nmfaf_3caDataManagement
description: | description: |
MFAF 3GPP Consumer Adaptor (3CA) Data Management Service. MFAF 3GPP Consumer Adaptor (3CA) Data Management Service.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.576 V19.2.0; 5G System; Messaging Framework Adaptor Services; Stage 3. description: 3GPP TS 29.576 V19.3.0; 5G System; Messaging Framework Adaptor Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/'
servers: servers:
......
TS29576_Nmfaf_3daDataManagement.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.2.0-alpha.2 version: 1.2.0-alpha.3
title: Nmfaf_3daDataManagement title: Nmfaf_3daDataManagement
description: | description: |
MFAF 3GPP DCCF Adaptor (3DA) Data Management Service. MFAF 3GPP DCCF Adaptor (3DA) Data Management Service.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.576 V19.2.0; 5G System; Messaging Framework Adaptor Services; Stage 3. description: 3GPP TS 29.576 V19.3.0; 5G System; Messaging Framework Adaptor Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/'
servers: servers:
......
TS29576_Nmfaf_ContextManagement.yaml
View file @ eee1c11e
openapi: 3.0.0 openapi: 3.0.0
info: info:
version: 1.0.0-alpha.2 version: 1.0.0-alpha.3
title: Nmfaf_ContextManagement title: Nmfaf_ContextManagement
description: | description: |
MFAF Context Management Service. MFAF Context Management Service.
...@@ -9,7 +9,7 @@ info: ...@@ -9,7 +9,7 @@ info:
All rights reserved. All rights reserved.
externalDocs: externalDocs:
description: 3GPP TS 29.576 V19.2.0; 5G System; Messaging Framework Adaptor Services; Stage 3. description: 3GPP TS 29.576 V19.3.0; 5G System; Messaging Framework Adaptor Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/' url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.576/'
servers: servers:
......