Skip to content
Show whitespace changes
Inline Side-by-side
TS29571_CommonData.yaml
View file @ d54f1ea3
openapi: 3.0.0
info:
version: '1.5.0'
version: '1.5.1'
title: 'Common Data Types'
......@@ -11,7 +11,7 @@ info:
All rights reserved.
externalDocs:
description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 18.6.0
description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 18.7.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.571/'
paths: {}
......@@ -5039,7 +5039,8 @@ components:
- GTP_DELAYDLPSAUPFNGRANMEAN_SNSSAI_QFI
- type: string
description: >
The enumeration MeasurementType defines Measurement Type in the UE level measurements trace.
The enumeration MeasurementType defines Measurement Type in the
5GC UE level measurements trace.
......@@ -5177,6 +5178,9 @@ components:
configured for Immediate MDT or combined Immediate MDT and Trace in LTE.
When present, this IE shall indicate the Event Threshold for RSRP, and the value shall
be between 0-97.
mnOnlyInd:
type: boolean
default: false
eventThresholdRsrpNr:
type: integer
......@@ -6352,6 +6356,11 @@ components:
description: IMS Session Identifier
type: string
Fingerprint:
description: The certificate fingerprint for the DTLS association.
type: string
pattern: '^(SHA-1|SHA-224|SHA-256|SHA-384|SHA-512|MD5|MD2)\s[0-9A-F]{2}(:[0-9A-F]{2})+$'
MediaId:
description: IMS Media Flow Identifier
type: string
......@@ -6362,6 +6371,11 @@ components:
maximum: 64
default: 64
TlsId:
description: The TLS ID for the media stream.
type: string
pattern: '^[A-Za-z0-9+/_-]{20,255}$'
#
# Enumerations
......@@ -6428,13 +6442,16 @@ components:
minimum: 0
description: Local or remote port for Data Channel
fingerprint:
type: string
pattern: '^(SHA-1|SHA-224|SHA-256|SHA-384|SHA-512|MD5|MD2|TOKEN)\s[0-9A-F]{2}(:[0-9A-F]{2})+'
description: local or remote certificate fingerprint for the DTLS association
deprecated: true
allOf:
- $ref: '#/components/schemas/Fingerprint'
fingerprints:
type: array
items:
$ref: '#/components/schemas/Fingerprint'
minItems: 1
tlsId:
type: string
pattern: '^[A-Fa-f0-9+/_-]{20,255}$'
description: local or remote TLS ID for the media stream
$ref: '#/components/schemas/TlsId'
securitySetup:
$ref: '#/components/schemas/SecuritySetup'
......@@ -6509,7 +6526,14 @@ components:
type: string
description: application binding information of the Data Channel.
appDcInfo:
deprecated: true
allOf:
- $ref: '#/components/schemas/AppDcInfo'
appDcInfoList:
type: array
items:
$ref: '#/components/schemas/AppDcInfo'
minItems: 1
AppDcInfo:
......@@ -6540,13 +6564,18 @@ components:
minimum: 0
description: Port number for SCTP connection over DTLS
fingerprint:
type: string
pattern: '^(SHA-1|SHA-224|SHA-256|SHA-384|SHA-512|MD5|MD2|TOKEN)\s[0-9A-F]{2}(:[0-9A-F]{2})+$'
description: Certificate fingerprint for the DTLS association
deprecated: true
allOf:
- $ref: '#/components/schemas/Fingerprint'
fingerprints:
type: array
items:
$ref: '#/components/schemas/Fingerprint'
minItems: 1
tlsId:
type: string
pattern: '^[A-Fa-f0-9+/_-]{20,255}$'
description: TLS ID for the DTLS connection
$ref: '#/components/schemas/TlsId'
securitySetup:
$ref: '#/components/schemas/SecuritySetup'
......
TS29573_N32_Handshake.yaml
View file @ d54f1ea3
openapi: 3.0.0
info:
version: '1.3.0'
version: '1.3.1'
title: 'N32 Handshake API'
description: |
N32-c Handshake Service.
......@@ -14,7 +14,7 @@ servers:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
externalDocs:
description: 3GPP TS 29.573 V18.7.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3
description: 3GPP TS 29.573 V18.8.0; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.573/
paths:
......@@ -39,7 +39,11 @@ paths:
schema:
$ref: '#/components/schemas/SecNegotiateRspData'
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
description: redirection
content:
application/problem+json:
schema:
$ref: '#/components/schemas/ExtRedirectResponse'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
......@@ -238,6 +242,7 @@ components:
- KEY_MATERIAL
- AUTHENTICATION_MATERIAL
- AUTHORIZATION_TOKEN
- RECURSIVE_NON_LEAF
- OTHER
- NONSENSITIVE
- type: string
......@@ -276,6 +281,8 @@ components:
additionalProperties:
type: boolean
minProperties: 1
ancestorIe:
type: string
ApiIeMapping:
description: API URI to IE mapping on which the protection policy needs to be applied
......@@ -646,3 +653,16 @@ components:
- RELEASE_REESTABLISHMENT_NOT_ALLOWED
- REESTABLISH
- type: string
ExtRedirectResponse:
description: Extension of the redirection response
allOf:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/RedirectResponse'
- $ref: '#/components/schemas/RedirectResponseAddInfo'
RedirectResponseAddInfo:
description: Additional information in the redirection response
type: object
properties:
seppFqdnForDiscovery:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn'
TS29574_Ndccf_DataManagement.yaml
View file @ d54f1ea3
openapi: 3.0.0
info:
version: 1.1.0
version: 1.1.1
title: Ndccf_DataManagement
description: |
DCCF Data Management Service.
......@@ -9,7 +9,7 @@ info:
All rights reserved.
externalDocs:
description: 3GPP TS 29.574 V18.6.0; 5G System; Data Collection Coordination Services; Stage 3.
description: 3GPP TS 29.574 V18.7.0; 5G System; Data Collection Coordination Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.574/'
#
servers:
......@@ -597,7 +597,7 @@ paths:
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
$ref: '#/components/schemas/DataTransferResp'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
......@@ -776,6 +776,7 @@ components:
- required: [anaNotifications]
- required: [anaReports]
- required: [fetchInstruct]
- required: [delAlert]
properties:
anaNotifCorrId:
type: string
......@@ -836,6 +837,8 @@ components:
description: Notification correlation identifier.
newSubscriptionUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
dataNotif:
$ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification'
dataReports:
......@@ -1099,6 +1102,19 @@ components:
or analytics that are about to be deleted.
required:
- retrievalInd
#
DataTransferResp:
description: >
Represents an Individual DCCF Data Subscription resource created at the
target DCCF.
type: object
properties:
newSubscriptionUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- newSubscriptionUri
#
SummarizationAttribute:
anyOf:
......
TS29575_Nadrf_MLModelManagement.yaml
View file @ d54f1ea3
openapi: 3.0.0
info:
version: 1.0.0
version: 1.0.1
title: Nadrf_MLModelManagement
description: |
ADRF ML Model Management Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.575 V18.6.0; 5G System; Analytics Data Repository Services; Stage 3.
description: 3GPP TS 29.575 V18.7.0; 5G System; Analytics Data Repository Services; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.575/'
#
servers:
......@@ -378,7 +378,7 @@ components:
type: object
allOf:
- required: [modelUniqueId]
- required: [DeleteResult]
- required: [deleteResult]
properties:
modelUniqueId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'
......@@ -427,7 +427,7 @@ components:
Represents the store result type.
Possible values are:
- ML_MODEL_DELETED: Indicates that the ML model was deleted in ADRF.
- ML_MODEL_FILE_ADDRESS_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.
#
......
TS29580_Nmbsf_MBSUserDataIngestSession.yaml
View file @ d54f1ea3
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: nmbsf-mbs-ud-ingest
version: 1.1.0
version: 1.1.1
description: |
API for MBS User Data Ingest Session Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.580 V18.5.0; 5G System; Multicast/Broadcast Service Function Services.
3GPP TS 29.580 V18.6.0; 5G System; Multicast/Broadcast Service Function Services.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.580/'
servers:
......@@ -749,6 +749,8 @@ components:
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
minItems: 1
actPeriodsRepRule:
$ref: 'TS26517_MBSUserServiceAnnouncement.yaml#/components/schemas/RepetitionRule'
mbsUserServAnmt:
$ref: '#/components/schemas/MBSUserServAnmt'
mbsUserServiceAnmt:
......@@ -774,6 +776,8 @@ components:
required:
- mbsUserServId
- mbsDisSessInfos
not:
required: [actPeriods, actPeriodsRepRule]
MBSDistributionSessionInfo:
description: Represents MBS Distribution Session information.
......@@ -849,6 +853,14 @@ components:
Subscription.
type: object
properties:
actPeriods:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
minItems: 1
nullable: true
actPeriodsRepRule:
$ref: '#/components/schemas/RepetitionRuleRm'
mbsDisSessInfos:
type: object
additionalProperties:
......@@ -859,11 +871,6 @@ components:
Contains the requested modifications to one or more MBS Distribution Session(s)
composing the MBS User Data Ingest Session.
The key of the map shall be any unique string encoded value.
actPeriods:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
minItems: 1
ObjectDistrMethInfo:
description: >
......@@ -1120,6 +1127,24 @@ components:
required:
- causes
RepetitionRuleRm:
description: >
Represents the same as the RepetitionRule data type defined in 3GPP TS 26.517 but with the
OpenAPI nullable property set to true.
type: object
properties:
startTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
duration:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
repetitionInterval:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
nullable: true
required:
- startTime
- duration
- repetitionInterval
# SIMPLE DATA TYPES
#
......
TS29591_Nnef_EASDeployment.yaml
View file @ d54f1ea3
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: Nnef_EASDeployment
version: 1.1.0
version: 1.1.1
description: |
NEF EAS Deployment service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.591 V18.6.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V18.8.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
......@@ -249,6 +249,8 @@ components:
type: string
notifUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- eventId
- notifId
......
TS29591_Nnef_ECSAddress.yaml
View file @ d54f1ea3
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: Nnef_ECSAddressConfigurationInformation
version: 1.0.0
version: 1.0.1
description: |
NEF ECS Address Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.591 V18.6.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V18.7.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
......@@ -392,8 +392,6 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 1
description: Each updated element identifies a slice.
internalGroupId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
immRepInd:
type: boolean
description: >
......
TS29591_Nnef_UEId.yaml
View file @ d54f1ea3
openapi: 3.0.0
info:
title: Nnef_UEId
version: 1.0.0
version: 1.0.1
description: |
NEF Traffic Correlation Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.591 V18.6.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V18.7.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
- url: '{apiRoot}/nnef-ueid/v1'
......@@ -101,6 +101,8 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/MapUeIdInfo'
'204':
description: No Content (The requested UE ID mapping information does not exist.)
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
......@@ -169,8 +171,7 @@ components:
- required: [uePvtIpAddr]
MapUeIdInfo:
description: >
Contains the UE ID mapping information.
description: Contains the UE ID mapping information.
type: object
properties:
appLayerId:
......
TS32291_Nchf_ConvergedCharging.yaml
View file @ d54f1ea3
openapi: 3.0.0
info:
title: Nchf_ConvergedCharging
version: 3.2.0-alpha.6
version: 3.2.0
description: |
ConvergedCharging Service © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 32.291 V18.6.0: Telecommunication management; Charging management;
3GPP TS 32.291 V18.7.0: Telecommunication management; Charging management;
5G system, charging service; Stage 3.
url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/'
servers:
......@@ -1046,9 +1046,10 @@ components:
$ref: '#/components/schemas/ReplyPathRequested'
sMUserDataHeader:
type: string
pattern: '^[0-9a-fA-F]+$'
sMStatus:
type: string
pattern: '^[0-7]?[0-9a-fA-F]$'
pattern: '^[0-9a-fA-F]{2}$'
sMDischargeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
numberofMessagesSent:
......
TS32291_Nchf_OfflineOnlyCharging.yaml
View file @ d54f1ea3
openapi: 3.0.0
info:
title: Nchf_OfflineOnlyCharging
version: 1.2.0-alpha.1
version: 1.2.0
description: |
OfflineOnlyCharging Service
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 32.291 V18.0.0: Telecommunication management; Charging management;
3GPP TS 32.291 V18.7.0: Telecommunication management; Charging management;
5G system, charging service; Stage 3.
url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/'
servers:
......