Skip to content
Show whitespace changes
Inline Side-by-side
TS29176_Nmf_MRM.yaml
View file @ 1a359940
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: 'MF Media Resource Management (MRM) Service'
version: 1.1.0-alpha.1
version: 1.1.0-alpha.2
description: |
MF Media Resource Management (MRM) Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.176 V19.1.0; IP Multimedia Subsystem (IMS); Media Function (MF) Services; Stage 3.
3GPP TS 29.176 V19.2.0; IP Multimedia Subsystem (IMS); Media Function (MF) Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.176/
servers:
......@@ -86,6 +86,8 @@ paths:
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'409':
$ref: 'TS29571_CommonData.yaml#/components/responses/409'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
......@@ -295,6 +297,15 @@ components:
properties:
mediaId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId'
associatedMediaIds:
description: >
media streams which are de-multiplexed from a multiplexed
media component with the value set to the media ID of the
original multiplexed media.
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MediaId'
minItems: 1
mediaResourceType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/MediaResourceType'
localMbEndpoint:
......@@ -306,13 +317,13 @@ components:
arMedia:
$ref: '#/components/schemas/ArMedia'
localNonDcMedia:
$ref: '#components/schemas/NonDcMedia'
$ref: '#/components/schemas/NonDcMedia'
remoteNonDcMedia:
$ref: '#components/schemas/NonDcMedia'
$ref: '#/components/schemas/NonDcMedia'
mediaProcessingUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
avatarMedia:
$ref: '#components/schemas/AvatarMedia'
$ref: '#/components/schemas/AvatarMedia'
DcMedia:
......@@ -386,11 +397,14 @@ components:
required:
- resourceUrl
- mediaProcessSpec
- renderingMode
properties:
resourceUrl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
mediaProcessSpec:
type: string
renderingMode:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RenderingMode'
NonDcMedia:
description: Represents the audio and video media
......
TS29222_CAPIF_API_Invoker_Management_API.yaml
View file @ 1a359940
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: CAPIF_API_Invoker_Management_API
version: 1.4.0-alpha.3
version: 1.4.0-alpha.4
description: |
API for API invoker management.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.222 V19.2.0 Common API Framework for 3GPP Northbound APIs
description: 3GPP TS 29.222 V19.3.0 Common API Framework for 3GPP Northbound APIs
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
servers:
......@@ -269,6 +269,12 @@ components:
scopes: {}
schemas:
#
# STRUCTURED DATA TYPES
#
OnboardingInformation:
type: object
description: Represents the on-boarding information of the API Invoker.
......@@ -339,6 +345,11 @@ components:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
failureReasons:
type: array
items:
$ref: '#/components/schemas/EnrolFailReason'
minItems: 1
required:
- onboardingInformation
- notificationDestination
......@@ -397,6 +408,11 @@ components:
properties:
aefIds:
type: string
apis:
type: array
items:
$ref: '#/components/schemas/ApiInfo'
minItems: 1
serviceAPICategories:
type: array
items:
......@@ -405,3 +421,82 @@ components:
anyOf:
- required: [aefIds]
- required: [serviceAPICategories]
- required: [apis]
ApiInfo:
type: object
description: Represents service API identification related information.
properties:
apiName:
type: string
supportedApiVersions:
type: array
items:
type: string
minItems: 1
required:
- apiName
EnrolFailReason:
type: object
description: Represents the failure reason for not those APIs not enrolled successfully.
properties:
apiName:
items:
type: string
failureCode:
$ref: '#/components/schemas/EnrolFailCause'
required:
- apiName
- failureCode
# SIMPLE DATA TYPES
#
# ENUMERATIONS DATA TYPES
#
EnrolFailCause:
anyOf:
- type: string
enum:
- AUTHORIZATION_ISSUE
- ONBOARDING_CRI_NOT_MET
- UNSPECIFIED
- 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 API Invoker's per API enrollment failure code.
Possible values are:
- AUTHORIZATION_ISSUE: Indicates that the service API enrollment failed because the service
API is not authorized for the API Invoker.
- ONBOARDING_CRI_NOT_MET: Indicates that the service API entollment failed because the
onboarding criteria not met for this service API for the API Invoker.
- UNSPECIFIED: Indicates that the service API enrollment failed due to an unspecified
reason.
OnboardingFailReason:
anyOf:
- type: string
enum:
- API_INVOKER_NOT_ALLOWED
- ONBOARDING_CRI_NOT_MET
- OTHER
- 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 API Invoker onboarding failure reason.
Possible values are:
- API_INVOKER_NOT_ALLOWED: Indicates that the onboarding of the API Invoker failed because
the API Invoker is not allowed.
- ONBOARDING_CRI_NOT_MET: Indicates that the onboarding of the API Invoker failed because
the onboarding criteria is not met.
- OTHER: Indicates that the onboarding of the API Invoker failed because of other reasons.
# Data types describing alternative data types or combinations of data types:
#
TS29222_CAPIF_Auditing_API.yaml
View file @ 1a359940
......@@ -4,12 +4,12 @@ info:
title: CAPIF_Auditing_API
description: |
API for auditing.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.4.0-alpha.1"
version: "1.4.0-alpha.2"
externalDocs:
description: 3GPP TS 29.222 V19.1.0 Common API Framework for 3GPP Northbound APIs
description: 3GPP TS 29.222 V19.3.0 Common API Framework for 3GPP Northbound APIs
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
servers:
......@@ -52,8 +52,8 @@ paths:
- name: api-name
in: query
description: >
API name, it is set as {apiName} part of the URI structure as defined in
clause 5.2.4 of 3GPP TS 29.122.
Contains the API name set to the value of the "<apiName>" placeholder of the API URI as
defined in clause 5.2.4 of 3GPP TS 29.122 [14].
schema:
type: string
- name: api-version
......
TS29222_CAPIF_Discover_Service_API.yaml
View file @ 1a359940
......@@ -6,10 +6,10 @@ info:
API for discovering service APIs.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.4.0-alpha.2"
version: "1.4.0-alpha.3"
externalDocs:
description: 3GPP TS 29.222 V19.2.0 Common API Framework for 3GPP Northbound APIs
description: 3GPP TS 29.222 V19.3.0 Common API Framework for 3GPP Northbound APIs
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
servers:
......@@ -37,8 +37,8 @@ paths:
- name: api-name
in: query
description: >
API name, it is set as {apiName} part of the URI structure as defined
in clause 5.2.4 of 3GPP TS 29.122.
Contains the API name set to the value of the "<apiName>" placeholder of the API URI as
defined in clause 5.2.4 of 3GPP TS 29.122 [14].
schema:
type: string
- name: api-version
......
TS29222_CAPIF_Logging_API_Invocation_API.yaml
View file @ 1a359940
......@@ -4,12 +4,12 @@ info:
title: CAPIF_Logging_API_Invocation_API
description: |
API for invocation logs.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.4.0-alpha.1"
version: "1.4.0-alpha.2"
externalDocs:
description: 3GPP TS 29.222 V19.1.0 Common API Framework for 3GPP Northbound APIs
description: 3GPP TS 29.222 V19.3.0 Common API Framework for 3GPP Northbound APIs
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
servers:
......@@ -128,8 +128,8 @@ components:
apiName:
type: string
description: >
Name of the API which was invoked, it is set as {apiName} part of the URI
structure as defined in clause 5.2.4 of 3GPP TS 29.122.
Contains the invoked API name set to the value of the "<apiName>" placeholder of the API
URI as defined in clause 5.2.4 of 3GPP TS 29.122 [14].
apiVersion:
type: string
description: Version of the API which was invoked
......
TS29222_CAPIF_Publish_Service_API.yaml
View file @ 1a359940
......@@ -6,10 +6,10 @@ info:
API for publishing service APIs.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.4.0-alpha.3"
version: "1.4.0-alpha.4"
externalDocs:
description: 3GPP TS 29.222 V19.2.0 Common API Framework for 3GPP Northbound APIs
description: 3GPP TS 29.222 V19.3.0 Common API Framework for 3GPP Northbound APIs
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
servers:
......@@ -85,7 +85,10 @@ paths:
type: string
responses:
'200':
description: Definition of all service API(s) published by the API publishing function.
description: >
Definition of all service API(s) published by the API publishing function.
If an empty array is provided, it indicates that there is no active published API at the
CCF.
content:
application/json:
schema:
......@@ -133,8 +136,7 @@ paths:
type: string
responses:
'200':
description: >
Definition of individual service API published by the API publishing function.
description: Definition of all service API(s) published by the API publishing function.
content:
application/json:
schema:
......@@ -323,8 +325,8 @@ components:
apiName:
type: string
description: >
API name, it is set as {apiName} part of the URI structure as defined in
clause 5.2.4 of 3GPP TS 29.122.
Contains the API name set to the value of the "<apiName>" placeholder of the API URI as
defined in clause 5.2.4 of 3GPP TS 29.122 [14].
apiId:
type: string
description: >
......@@ -547,6 +549,7 @@ components:
required:
- apiVersion
ShareableInformation:
type: object
description: >
......@@ -556,9 +559,12 @@ components:
isShareable:
type: boolean
description: >
Set to "true" indicates that the service API and/or the service API
category can be shared to the list of CAPIF provider domain information.
Otherwise set to "false".
Indicates whether the service API and/or the service API category can be shared to the
list of CAPIF provider domain information.
true indicates that the service API and/or the service API category can be shared to the
list of CAPIF provider domain information.
false indicates that the service API and/or the service API category can not be shared
to the list of CAPIF provider domain information.
capifProvDoms:
type: array
items:
......@@ -636,7 +642,6 @@ components:
description: >
Indicates the list of AEF ID(s) where the API is active.
If an empty array is provided, it indicates that the API is inactive in all AEF(s).
required:
- aefIds
......
TS29222_CAPIF_Security_API.yaml
View file @ 1a359940
......@@ -4,12 +4,12 @@ info:
title: CAPIF_Security_API
description: |
API for CAPIF security management.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.3.0"
version: "1.4.0-alpha.1"
externalDocs:
description: 3GPP TS 29.222 V18.6.0 Common API Framework for 3GPP Northbound APIs
description: 3GPP TS 29.222 V19.3.0 Common API Framework for 3GPP Northbound APIs
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.222/
servers:
......
TS29256_Nnef_Authentication.yaml
View file @ 1a359940
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: Nnef_Authentication
version: '1.2.0-alpha.1'
version: '1.2.0-alpha.2'
description: |
NEF Auth Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.256 V19.0.0; 5G System;Uncrewed Aerial Systems Network Function (UAS-NF);
3GPP TS 29.256 V19.2.0; 5G System;Uncrewed Aerial Systems Network Function (UAS-NF);
Aerial Management Services; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.256/
......@@ -170,6 +170,7 @@ components:
authProfIndex:
type: string
AuthNotification:
description: UAV related notification
type: object
......
TS29257_UAE_NTZManagement.yaml
View file @ 1a359940
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: UAE Server NTZ Management Service
version: 1.0.0-alpha.2
version: 1.0.0-alpha.3
description: |
UAE Server NTZ Management Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.257 V19.2.0; Application layer support for Uncrewed Aerial System (UAS);
3GPP TS 29.257 V19.3.0; Application layer support for Uncrewed Aerial System (UAS);
UAS Application Enabler (UAE) Server Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/
......@@ -468,8 +468,8 @@ components:
type: string
ntzArea:
$ref: 'TS29257_UAE_ChangeUSSManagement.yaml#/components/schemas/ServArea'
validity:
$ref: '#/components/schemas/TimeValidityReqs'
altitudeReqs:
$ref: '#/components/schemas/AltitudeReqs'
freqBands:
type: array
items:
......@@ -485,7 +485,7 @@ components:
required:
- ntzPolId
- ntzArea
- validity
- altitudeReqs
- freqBands
nullable: true
......@@ -558,9 +558,7 @@ components:
freqBands:
type: array
items:
type: integer
minimum: 0
maximum: 262143
$ref: '#/components/schemas/FreqBand'
minItems: 1
required:
- status
......@@ -587,16 +585,26 @@ components:
properties:
name:
$ref: '#/components/schemas/FreqBandName'
otherName:
type: string
value:
type: integer
minimum: 0
maximum: 262143
type: string
restrictedTimeReqs:
$ref: '#/components/schemas/TimeValidityReqs'
required:
- name
- value
AltitudeReqs:
description: Represents the altitude related requirements for NTZ.
type: object
properties:
floorLimit:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
ceilingLimit:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
anyOf:
- required: [floorLimit]
- required: [ceilingLimit]
# SIMPLE DATA TYPES
#
......@@ -662,10 +670,8 @@ components:
anyOf:
- type: string
enum:
- ARFCN
- EARFCN
- NR_EARFCN
- OTHER
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
......@@ -673,10 +679,8 @@ components:
description: |
Represents the frequency band name.
Possible values are:
- ARFCN: Indicates that the frequency band name is ARFCN.
- EARFCN: Indicates that the frequency band name is EARFCN.
- NR_EARFCN: Indicates that the frequency band name is NR-EARFCN.
- OTHER: Indicates that the frequency band name is another name.
- EARFCN: Indicates that the frequency band name is EARFCN (i.e., E-UTRA frequency band).
- NR_EARFCN: Indicates that the frequency band name is NR-EARFCN (i.e., NR frequency band).
# Data types describing alternative data types or combinations of data types
......
TS29369_Nadm_DM.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
version: '1.0.0-alpha.2'
title: 'Nadm_DM'
description: |
Nadm Data Management Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.xxx Ambient IoT Data Management Services, version 0.2.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.xxx/'
servers:
- url: '{apiRoot}/nadm-dm/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501.
security:
- oAuth2ClientCredentials:
- nadm-dm
- {}
paths:
/aiot-device-profile-data/{aiotDevPermId}:
get:
summary: get AIoT Device Profile Data
operationId: Get AIoT Device Profile Data
tags:
- AIoT Device Profile Data Retrieval
parameters:
- name: aiotDevPermId
in: path
description: AIoT Device Permanent ID
required: true
schema:
$ref: '#/components/schemas/AiotDevPermId'
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/AiotDevProfileData'
'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'
'406':
$ref: 'TS29571_CommonData.yaml#/components/responses/406'
'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:
description: Unexpected error
patch:
summary: modify AIoT Device Profile Data
operationId: Modify AIoT Device Profile Data
tags:
- AIoT Device Profile Data Updata
parameters:
- name: aiotDevPermId
in: path
description: AIoT Device Permanent ID
required: true
schema:
$ref: '#/components/schemas/AiotDevPermId'
- name: supported-features
in: query
description: Features required to be supported by the target NF
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
requestBody:
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/AiotDevProfileData'
required: true
responses:
'204':
description: Expected response to a valid request
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult'
'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:
description: Unexpected error
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nadm-dm: Access to the Nadm_DM API
nadm-dm:aiot-device-profile-data:read: Access to read AIoT Device Profile Data
nadm-dm:aiot-device-profile-data:modify: Access to update AIoT Device Profile Data
schemas:
#
# STRUCTURED TYPES
#
AiotDevProfileData:
description: Contains the AIoT Device Profile Data.
type: object
required:
- aiotDevPermId
- lastKnownAiotfInfo
properties:
aiotDevPermId:
$ref: '#/components/schemas/AiotDevPermId'
lastKnownAiotfInfo:
$ref: '#/components/schemas/LastKnownAiotfInfo'
LastKnownAiotfInfo:
description: Contains the Last Known AIoTF Info.
type: object
required:
- lastKnownAiotfInfoInd
properties:
lastKnownAiotfInfoInd:
$ref: '#/components/schemas/LastKnownAiotfInfoInd'
#
# SIMPLE TYPES
#
AiotDevPermId:
description: Indicates the AIoT device permanent identifier
type: string
LastKnownAiotfInfoInd:
description: Indicates the Last Known AIoTF information indication
type: boolean
#
# ENUMS
#
TS29437_SS_SAnDiscovery.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: SAn Server Spatial Anchors Discovery Service
version: 1.0.0-alpha.2
description: |
API for Spatial Anchors Discovery Service.
©2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.437 V1.0.0; Service Enabler Architecture Layer for Verticals (SEAL);
Metaverse Enablement Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.437/
servers:
- url: "{apiRoot}/ssan_disc/v1"
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/spatial-anchors:
get:
summary: Discover Spatial Anchors profiles.
operationId: DiscSpatialAnchorsProfiles
tags:
- Spatial Anchors (Collection)
parameters:
- name: anchor-ids
in: query
description: Contains the identifier(s) of the targeted spatial anchor(s).
content:
application/json:
schema:
type: array
items:
$ref: 'TS29437_SS_SAnManagement.yaml#/components/schemas/SpatialAnchorId'
minItems: 1
- name: area-int
in: query
description: >
Contains the area of interest within which the targeted spatial anchors are located.
content:
application/json:
schema:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'
- name: svc-id
in: query
description: Contains the identifier of the target VAL service.
schema:
type: string
- name: anch-inf
in: query
description: >
Contains the application specific information of the targeted spatial anchors.
content:
application/json:
schema:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes'
- name: supp-feats
in: query
description: >
Contains the list of supported feature(s) among the ones defined in clause 6.1.2.8.
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
responses:
'200':
description: >
OK. The Spatial Anchors profiles matching the filter criteria are returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsDiscResp'
'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'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: "{tokenUrl}"
scopes: {}
schemas:
#
# STRUCTURED DATA TYPES
#
SpatialAnchorsDiscResp:
description: >
Represents the Spatial Anchors discovery response.
type: object
properties:
results:
type: array
items:
type: string
minItems: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- results
# SIMPLE DATA TYPES
#
#
# ENUMERATIONS
#
# Data types describing alternative data types or combinations of data types:
#
TS29437_SS_SAnManagement.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: SAn Server Spatial Anchors Management Service
version: 1.0.0-alpha.3
description: |
API for Spatial Anchor Management Service.
©2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.437 V1.0.0; Service Enabler Architecture Layer for Verticals (SEAL);
Metaverse Enablement Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.437/
servers:
- url: "{apiRoot}/san_sanm/v1"
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/anchors-lists:
post:
summary: Create a new Spatial Anchors List.
operationId: CreateSpatialAnchorsList
tags:
- Spatial Anchors List (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsList'
responses:
'201':
description: >
Created. The Spatial Anchors List is successfully created and a representation of the
created Individual Spatial Anchors List resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsList'
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/anchors-lists/{anchorsListId}:
parameters:
- name: anchorsListId
in: path
description: Represents the identifier of the Individual Spatial Anchors List resource.
required: true
schema:
type: string
get:
summary: Retrieve an existing Individual Spatial Anchors List.
operationId: GetIndSpatialAnchorsList
tags:
- Individual Spatial Anchors List (Document)
responses:
'200':
description: >
OK. The requested Individual Spatial Anchors List resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsList'
'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 Spatial Anchors list.
operationId: UpdateIndSpatialAnchorsList
tags:
- Individual Spatial Anchors List (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsList'
responses:
'200':
description: >
OK. The Individual Spatial Anchors List resource is successfully updated and
a representation of the updated resource shall be returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsList'
'204':
description: >
No Content. The Individual Spatial Anchors List resource is successfully updated and no
content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Modify an existing Individual Spatial Anchors List.
operationId: ModifyIndSpatialAnchorsList
tags:
- Individual Spatial Anchors List (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsList'
responses:
'200':
description: >
OK. The Individual Spatial Anchors List resource is successfully modified and
a representation of the updated resource shall be returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsList'
'204':
description: >
No Content. The Individual Spatial Anchors List resource is successfully modified and no
content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Delete an existing Individual Spatial Anchors List.
operationId: DeleteIndSpatialAnchorsList
tags:
- Individual Spatial Anchors List
responses:
'204':
description: >
No Content. The 'Individual Spatial Anchors List' resource is successfully deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions:
post:
summary: Create a new Spatial Anchors Subscription.
operationId: CreateSpatialAnchorsSubsc
tags:
- Spatial Anchors Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsSub'
responses:
'201':
description: >
Created. The Spatial Anchors Subscription is successfully created and a
representation of the created Individual Spatial Anchors Subscription
resource shall be returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsSub'
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
SpatialAnchorsNotif:
'{$request.body#/notifUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsNotif'
responses:
'204':
description: >
No Content. The Spatial Anchors Notification is successfully
received and acknowledged.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
parameters:
- name: subscriptionId
in: path
description: >
Represents the identifier of the Spatial Anchors Subscription.
required: true
schema:
type: string
get:
summary: Retrieve an existing Individual Spatial Anchors Subscription resource.
operationId: GetIndSpatialAnchorsSubsc
tags:
- Individual Spatial Anchors Subscription (Document)
responses:
'200':
description: >
OK. The requested Individual Spatial Anchors Subscription
resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsSub'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Request the update of an existing Individual Spatial Anchors Subscription resource.
operationId: UpdateIndSpatialAnchorsSubsc
tags:
- Individual Spatial Anchors Subscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsSub'
responses:
'200':
description: >
OK. The Individual Spatial Anchors Subscription resource is successfully
updated and a representation of the updated resource shall be returned in the response
body.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsSub'
'204':
description: >
No Content. The Individual Spatial Anchors Subscription resource is
successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Request the modification of an existing Individual Spatial Anchors Subscription resource.
operationId: ModifyIndSpatialAnchorsSubsc
tags:
- Individual Spatial Anchors Subscription (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/SpatialAnchorsSubPatch'
responses:
'200':
description: >
OK. The Individual Spatial Anchors Subscription resource is successfully
modified and a representation of the updated resource shall be returned in the response
body.
content:
application/json:
schema:
$ref: '#/components/schemas/SpatialAnchorsSub'
'204':
description: >
No Content. The Individual Spatial Anchors Subscription resource is
successfully modified and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Request the deletion of an existing Individual Spatial Anchors Subscription resource.
operationId: RemoveIndSpatialAnchorsSubsc
tags:
- Individual Spatial Anchors Subscription (Document)
responses:
'204':
description: >
The Individual Spatial Anchors Subscription resource
is successfully deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: "{tokenUrl}"
scopes: {}
schemas:
#
# STRUCTURED DATA TYPES
#
SpatialAnchorsList:
description: >
Represents the Spatial Anchors List.
type: object
properties:
valServInfo:
$ref: '#/components/schemas/VALServiceInfo'
anchors:
type: object
additionalProperties:
$ref: '#/components/schemas/SpatialAnchor'
minProperties: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- valServInfo
- anchors
SpatialAnchorsListPatch:
description: >
Represents the patch of Spatial Anchors List.
type: object
properties:
valServInfo:
$ref: '#/components/schemas/VALServiceInfo'
anchors:
type: object
additionalProperties:
$ref: '#/components/schemas/SpatialAnchorRm'
minProperties: 1
VALServiceInfo:
description: >
Represents the VAL service information.
type: object
properties:
serviceId:
type: string
endPt:
$ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo'
servConInfo:
$ref: "#/components/schemas/ServConnectInfo"
required:
- serviceId
- endPt
ServConnectInfo:
description: >
Represents the connectivity information related to the application service.
type: object
properties:
dnais:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems: 1
dnn:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
anyOf:
- required: [dnais]
- required: [dnn]
SpatialAnchor:
description: >
Represents the Spatial Anchor profile information.
type: object
properties:
anchorId:
$ref: '#/components/schemas/SpatialAnchorId'
posInfo:
$ref: '#/components/schemas/PositionInfo'
specInfo:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes'
svcArea:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'
rules:
$ref: '#/components/schemas/AllowedRules'
required:
- posInfo
SpatialAnchorRm:
description: >
Represents the Spatial Anchor profile information.
type: object
properties:
anchorId:
$ref: '#/components/schemas/SpatialAnchorId'
posInfo:
$ref: '#/components/schemas/PositionInfo'
specInfo:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes'
svcArea:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'
rules:
$ref: '#/components/schemas/AllowedRules'
required:
- posInfo
nullable: true
AllowedRules:
description: >
Represents the access control rules.
type: object
properties:
allowedEntities:
type: array
items:
$ref: '#/components/schemas/AllowedEntity'
minItems: 1
valServiceList:
type: array
items:
type: string
minItems: 1
anyOf:
- required: [allowedEntities]
- required: [valServiceList]
AllowedEntity:
description: >
Represents the allowed application entity.
type: object
properties:
type:
$ref: '#/components/schemas/EntityType'
identifier:
type: string
anyOf:
- required: [type]
- required: [identifier]
PositionInfo:
description: >
Represents the positioning information of the Spatial Anchor and the related Spatial Map.
type: object
properties:
pos:
$ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Local3dPointUncertaintyEllipsoid'
spaMapPos:
$ref: '#/components/schemas/SpatialAnchorMapPosition'
anyOf:
- required: [pos]
- required: [spaMapPos]
SpatialAnchorMapPosition:
description: >
Represents the Spatial map positioning of the Spatial Anchor.
type: object
properties:
spaMapId:
type: string
description: Contains the Spatial Map Identifier.
spaMapLayerId:
type: array
items:
type: string
minItems: 1
description: Contains the identifier(s) of Spatial Map layer(s).
localInfo:
$ref: '#/components/schemas/LocalizationInfo'
required:
- spaMapId
LocalizationInfo:
description: >
Represents the localization information of the Spatial Anchor.
type: object
properties:
localInfo:
type: string
description: Contains the localization information.
SpatialAnchorsSub:
description: >
Represents the Spatial Anchors subscription.
type: object
properties:
eventSubs:
type: array
items:
$ref: '#/components/schemas/AnchorsEventsSub'
minItems: 1
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
report:
$ref: '#/components/schemas/SpatialAnchorsNotif'
reportReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- eventSubs
- notifUri
SpatialAnchorsSubPatch:
description: >
Represents the partial Spatial Anchors subscription.
type: object
properties:
eventSubs:
type: array
items:
$ref: '#/components/schemas/AnchorsEventsSub'
minItems: 1
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
reportReq:
$ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
SpatialAnchorsNotif:
description: >
Represents the Spatial Anchors Notification.
type: object
properties:
subId:
type: string
reports:
type: array
items:
$ref: '#/components/schemas/AnchorsReport'
minItems: 1
required:
- subId
- reports
AnchorsReport:
description: >
Represents the Spatial Anchors report.
type: object
properties:
event:
$ref: '#/components/schemas/AnchorEvent'
detEvent:
$ref: '#/components/schemas/DetectedEvent'
achrList:
type: array
items:
type: string
minItems: 1
ueAnchrInt:
type: array
items:
$ref: '#/components/schemas/UEAnchorInterest'
minItems: 1
required:
- event
UEAnchorInterest:
description: >
Represents the UE with Spatial Anchors interest.
type: object
properties:
ueId:
type: string
anchrId:
$ref: '#/components/schemas/SpatialAnchorId'
anchrRng:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
anyOf:
- required: [ueId]
- required: [anchrId]
- required: [anchrRng]
AnchorsEventsSub:
description: >
Represents the Spatial Anchors subscription event and filters.
type: object
properties:
event:
$ref: '#/components/schemas/AnchorEvent'
evntFltr:
$ref: '#/components/schemas/EventFilter'
required:
- event
- evntFltr
EventFilter:
description: >
Represents the Spatial Anchors Event filters.
type: object
properties:
discFltr:
$ref: '#/components/schemas/DiscoveryFilter'
ueFltr:
$ref: '#/components/schemas/UeFilter'
rngFltr:
$ref: '#/components/schemas/RangeFilter'
anchrFltr:
$ref: '#/components/schemas/AnchorFilter'
DiscoveryFilter:
description: >
Represents the Spatial Anchors discovery event filters.
type: object
properties:
mgntEvts:
type: array
items:
$ref: '#/components/schemas/AnchorManagementEvent'
minItems: 1
required:
- mgntEvts
UeFilter:
description: >
Represents the UE with spatial anchors event filters.
type: object
properties:
rngVal:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
disc:
type: boolean
description: >
Indicates whether the UEs that have discovered spatial anchors are to be
included in the report. When present, it shall be set as follows:
true: include UEs that discovered the spatial anchors.
false: not include UEs that discovered the spatial anchors.
Default value when omitted is "false".
required:
- rngVal
RangeFilter:
description: >
Represents the Spatial Anchors in range event filters.
type: object
properties:
perSrch:
type: boolean
description: >
Contains the persistent search preference. When present, it shall be set as follows:
true: enable persistent search.
false: not enable persistent search.
Default value when omitted is "false".
usrLoc:
$ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo'
pose:
type: string
appRng:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
specInfo:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Bytes'
required:
- appRng
AnchorFilter:
description: >
Represents the applicable spatial anchors filters.
type: object
properties:
anchIds:
type: array
items:
$ref: '#/components/schemas/SpatialAnchorId'
minItems: 1
svcIds:
type: array
items:
type: string
minItems: 1
areaInt:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ServiceArea'
anyOf:
- required: [anchIds]
- required: [svcIds]
- required: [areaInt]
# SIMPLE DATA TYPES
#
SpatialAnchorId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
#
# ENUMERATIONS
#
EntityType:
anyOf:
- type: string
enum:
- VAL_SERVER
- VAL_CLIENT
- 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 entity.
Possible values are:
- VAL_SERVER: Indicates that the entity type is a VAL Server
- VAL_CLIENT: Indicates that the entity type is VAL Client.
AnchorEvent:
anyOf:
- type: string
enum:
- ANCHOR_DISCOVERY
- UE_SPATIAL_ANCHOR_INTEREST
- SPATIAL_ANCHOR_IN_RANGE
- 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 entity.
Possible values are:
- ANCHOR_DISCOVERY: Indicates that the Spatial Anchors event is spatial anchors dicovery.
- UE_SPATIAL_ANCHOR_INTEREST: Indicates that the Spatial Anchors event is the UE
with spatial anchors interest.
- SPATIAL_ANCHOR_IN_RANGE: Indicates that the Spatial Anchors event is the
spatial anchors in range.
AnchorManagementEvent:
anyOf:
- type: string
enum:
- ANCHOR_CREATION
- ANCHOR_UPDATE
- ANCHOR_DELETION
- 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 entity.
Possible values are:
- ANCHOR_CREATION: Indicates that the spatial anchor management event is
spatial anchor creation.
- ANCHOR_UPDATE: Indicates that the spatial anchor management event is
spatial anchor updation.
- ANCHOR_DELETION: Indicates that the spatial anchor management event is
spatial anchor deletion.
DetectedEvent:
anyOf:
- type: string
enum:
- ANCHOR_IN_RANGE_OF_UE
- ANCHOR_OUT_RANGE_OF_UE
- UE_IN_RANGE_OF_ANCHOR
- UE_OUT_RANGE_OF_ANCHOR
- 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 entity.
Possible values are:
- ANCHOR_IN_RANGE_OF_UE: Indicates that the triggered event is spatial anchor
in range of the UE.
- ANCHOR_OUT_RANGE_OF_UE: Indicates that the triggered event is spatial anchor
out of range of the UE.
- UE_IN_RANGE_OF_ANCHOR: Indicates that the triggered event is UE entering
in range of spatial anchor.
- UE_OUT_RANGE_OF_ANCHOR: Indicates that the triggered event is UE leaving
the range of spatial anchor.
# Data types describing alternative data types or combinations of data types:
#
TS29522_RetrieveInfoUAVFlight.yaml → TS29482_AIMLES_ContextTransfer.yaml
View file @ 1a359940
openapi: 3.0.0
info:
title: 3gpp-retrieve-uav-flight
title: AIMLE Context Transfer Information Service
version: 1.0.0-alpha.2
description: |
API for UE Address service.
AIMLE Context Trnaser Information 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.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/'
security:
- {}
- oAuth2ClientCredentials: []
description: >
3GPP TS 29.482 v1.0.0; Artificial Intelligence Machine Learning Enablement
(AIMLE) Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.482/
servers:
- url: '{apiRoot}/3gpp-retrieve-uav-flight/v1'
- url: '{apiRoot}/aimles-ct/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122
security:
- {}
- oAuth2ClientCredentials: []
paths:
/{afId}/retrieve:
parameters:
- name: afId
in: path
description: Represents the identifier of the AF.
required: true
schema:
type: string
paths:
/request-trans:
post:
summary: Request to retrieve UAV flight information.
operationId: RetrieveUAVFlightInfo
summary: Request to send AIMLE context transfer information.
operationId: Request
tags:
- Retrieve
- AIMLE Context Transfer Request
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RetrieveUAVFlightReq'
$ref: '#/components/schemas/TransReq'
responses:
'200':
'204':
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/RetrievedUAVFlightInfo'
No Content. The AIMLE context transfer information is successfully received and processed.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
......@@ -80,6 +71,7 @@ paths:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
......@@ -89,74 +81,63 @@ components:
scopes: {}
schemas:
RetrieveUAVFlightReq:
description: Represents the parameters to request UAV Flight information.
TransReq:
description: >
Represents the AIMLE context transfer information.
type: object
properties:
gpsi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
retrievePurpose:
$ref: '#/components/schemas/RetrievePurpose'
targetUssList:
type: array
items:
aimleClientId:
$ref: '#/components/schemas/AimleClientId'
aimleServerId:
type: string
minItems: 1
canFltPathInfos:
aimleServerIds:
type: array
items:
$ref: '#/components/schemas/CandidateFlightPathInfo'
type: string
minItems: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
aimleServStatus:
$ref: '#/components/schemas/AimleServStatus'
required:
- gpsi
- retrievePurpose
CandidateFlightPathInfo:
description: Represents the candidate flight path information.
type: object
properties:
canFlightPath:
$ref: 'TS29522_UAVFlightAssistance.yaml#/components/schemas/FlightPath'
- aimleClientId
RetrievedUAVFlightInfo:
description: Represents the UAV Flight information.
AimleServStatus:
description: >
Represents the AIMLE service status information.
type: object
properties:
retrievedResults:
type: array
items:
$ref: 'TS29522_UAVFlightAssistance.yaml#/components/schemas/UAVFlightAssistNotif'
minItems: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
aimleServOpStatus:
$ref: '#/components/schemas/AimleServOpStatus'
aimleServOpPercent:
type: integer
minimum: 0
maximum: 100
required:
- retrievedResults
- aimleServOpStatus
#
# SIMPLE DATA TYPES
#
AimleClientId:
description: Represents unique identifier of a AIMLE client.
type: string
#
# ENUMERATIONS
#
RetrievePurpose:
AimleServOpStatus:
anyOf:
- type: string
enum:
- USS_CHANGEOVER
- PRE_FLIGHT_PLANNING
- ACTIVE
- PAUSED
- 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.
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 purpose of the retrieved UAV flight information.
Represents the AIMLE service operation status.
Possible values are:
- USS_CHANGEOVER: Indicates that the purpose of retrieved UAV Flight information is USS
changeover.
- PRE_FLIGHT_PLANNING: Indicates that the purpose of retrieved UAV Flight information is
pre-flight planning.
- ACTIVE: Indicates the status of the AIML operations at the AIMLE client is active.
- PAUSED: Indicates the status of the AIML operations at the AIMLE client is paused.
TS29482_AIMLES_DataManagement.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: Aimles_DataManagement
description: |
API for AIMLE Data Management assistance Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.0.0-alpha.2"
externalDocs:
description: >
3GPP TS 29.482 v1.0.0; Artificial Intelligence Machine Learning Enablement
(AIMLE) Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
servers:
- url: '{apiRoot}/aimles-dm/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122
security:
- {}
- oAuth2ClientCredentials: []
paths:
/subscriptions:
post:
summary: Request the creation of a Individual AIMLE Data Management Assistance Subscription.
operationId: CreateAimleDmAssistSubscription
tags:
- AIMLE Data Management Assistance Subscriptions (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DataMgmtAssistSubsc'
responses:
'201':
description: >
The requested Individual AIMLE Data Management Assistance Subscription is successfully
created and a representation of the created resource is returned in the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/DataMgmtAssistSubsc'
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
callbacks:
myNotification:
'{$request.body#/notifUri}':
post:
summary: Notify on the requested data.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DataMgmtAssistNotif'
responses:
'204':
description: The notification is successfully received.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
parameters:
- name: subscriptionId
in: path
description: >
Represents the Individual AIMLE Data Management Assistance Subscription resource.
required: true
schema:
type: string
get:
summary: Retrieve an existing the Individual AIMLE Data Management Assistance Subscription resource.
operationId: GetIndAimleDmAssistSubscription
tags:
- Individual AIMLE Data Management Assistance Subscription (Document)
responses:
'200':
description: >
OK. The requested Individual AIMLE Data Management Assistance Subscription resource
shall be returned.
content:
application/json:
schema:
$ref: '#/components/schemas/DataMgmtAssistSubsc'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'406':
$ref: 'TS29122_CommonData.yaml#/components/responses/406'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
put:
summary: Request the update of an existing Individual AIMLE Data Management Assistance Subscription resource.
operationId: UpdateIndAimleDmAssistSubscription
tags:
- Individual AIMLE Data Management Assistance Subscription (Document)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DataMgmtAssistSubsc'
responses:
'200':
description: >
OK. The Individual AIMLE Data Management Assistance Subscription resource is
successfully updated and a representation of the updated resource shall be returned in
the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/DataMgmtAssistSubsc'
'204':
description: >
No Content. The Individual AIMLE Data Management Assistance Subscription resource is
successfully updated and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
patch:
summary: Request the modification of an existing Individual AIMLE Data Management Assistance Subscription resource.
operationId: ModifyIndAimleDmAssistSubscription
tags:
- Individual AIMLE Data Management Assistance Subscription (Document)
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/DataMgmtAssistSubscPatch'
responses:
'200':
description: >
OK. The Individual AIMLE Data Management Assistance Subscription resource is
successfully modified and a representation of the updated resource shall be returned in
the response body.
content:
application/json:
schema:
$ref: '#/components/schemas/DataMgmtAssistSubsc'
'204':
description: >
No Content. The Individual AIMLE Data Management Assistance Subscription resource is
successfully modified and no content is returned in the response body.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
delete:
summary: Remove the Individual AIMLE Data Management Assistance Subscription.
operationId: UnsubscribeAimleDmAssistSubscription
tags:
- Individual AIMLE Data Management Assistance Subscription (Document).
responses:
'204':
description: >
The individual AIMLE Data Management Assistance Subscription resource matching the
subscriptionId is deleted.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
DataMgmtAssistSubsc:
description: Represents the AIMLE Data Management Assistance subscription information.
type: object
properties:
clientList:
type: array
items:
$ref: '#/components/schemas/AimleClientId'
minItems: 1
dataMgmtOp:
$ref: '#/components/schemas/DataMgmtOp'
dataPrepReqs:
$ref: '#/components/schemas/DataPrepReqs'
dataAnalysisReqs:
$ref: '#/components/schemas/DataAnalysisReqs'
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- dataMgmtOp
- notifUri
DataMgmtAssistNotif:
description: Represents the AIMLE Data Management Assistance notification.
type: object
properties:
dataMgmtOp:
$ref: '#/components/schemas/DataMgmtOp'
timestamp:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
required:
- dataMgmtOp
DataPrepReqs:
description: Represents the data preparation requirement.
type: object
properties:
dataSetId:
type: string
dataOperRequirement:
type: array
items:
$ref: '#/components/schemas/DataOperRequirement'
minItems: 1
required:
- dataSetId
- dataOperRequirement
DataAnalysisReqs:
description: Represents the data analysis requirement.
type: object
properties:
dataSetId:
type: string
dataOperRequirement:
type: array
items:
$ref: '#/components/schemas/DataOperRequirement'
minItems: 1
required:
- dataSetId
- dataOperRequirement
DataOperRequirement:
description: Represents the data analysis requirement.
type: object
properties:
dataId:
type: string
dataSetFeatureId:
type: string
required:
- dataId
- dataSetFeatureId
DataMgmtAssistSubscPatch:
description: >
Represents the requested modifications to a AIMLE Data Management Assistance subscription.
type: object
properties:
dataPrepReqs:
$ref: '#/components/schemas/DataPrepReqs'
dataAnalysisReqs:
$ref: '#/components/schemas/DataAnalysisReqs'
notifUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
# SIMPLE DATA TYPES
#
AimleClientId:
description: >
Represents unique identifier of a AIMLE client
type: string
# ENUMERATIONS
DataMgmtOp:
anyOf:
- type: string
enum:
- DATA_PREPARATION
- DATA_ANALYSIS
- 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: |
Indicates the data management operation type.
Possible values are:
- DATA_PREPARATION: The data management operation type is data preparation.
- DATA_ANALYSIS: The data management operation type is data analysis.
TS29486_VAE_MessageDelivery.yaml
View file @ 1a359940
openapi: 3.0.0
info:
version: 1.3.0-alpha.2
version: 1.3.0-alpha.3
title: VAE_MessageDelivery
description: |
API for VAE Message Delivery Service
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.486 V19.1.0 V2X Application Enabler (VAE) Services
description: 3GPP TS 29.486 V19.2.0 V2X Application Enabler (VAE) Services
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.486/'
security:
......
TS29500_CustomHeaders.abnf
View file @ 1a359940
......@@ -232,9 +232,9 @@ token68 = 1*( ALPHA / DIGIT / "-" / "." / "_" / "~" / "+" / "/" ) *"="
; ----------------------------------------
; 3GPP TS 29.500
;
; Version: 19.0.0 (September 2024)
; Version: 19.3.0 (June 2025)
;
; (c) 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
; (c) 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
; ----------------------------------------
;
......@@ -574,6 +574,8 @@ peertype = "srcinst"
/ "dstservinst"
/ "dstscp"
/ "dstsepp"
/ "dstfqdn"
/ "srcfqdn"
......
TS29502_Nsmf_PDUSession.yaml
View file @ 1a359940
openapi: 3.0.0
info:
version: '1.4.0-alpha.3'
version: '1.4.0-alpha.4'
title: 'Nsmf_PDUSession'
description: |
SMF PDU Session Service.
......@@ -9,7 +9,7 @@ info:
All rights reserved.
externalDocs:
description: 3GPP TS 29.502 V19.2.0; 5G System; Session Management Services; Stage 3
description: 3GPP TS 29.502 V19.3.0; 5G System; Session Management Services; Stage 3
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.502/
servers:
......@@ -2101,6 +2101,8 @@ components:
$ref: '#/components/schemas/QosMonitoringPdSupported'
qosMonitoringCongestionSupported:
$ref: '#/components/schemas/QosMonitoringCongestionSupported'
availBitRateMonSupported:
$ref: '#/components/schemas/AvailBitRateMonSupported'
ueLevelMeasConfig:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UeLevelMeasurementsConfiguration'
pgwChangeInd:
......@@ -2344,6 +2346,8 @@ components:
$ref: '#/components/schemas/QosMonitoringPdSupported'
qosMonitoringCongestionSupported:
$ref: '#/components/schemas/QosMonitoringCongestionSupported'
availBitRateMonSupported:
$ref: '#/components/schemas/AvailBitRateMonSupported'
ueLevelMeasConfig:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UeLevelMeasurementsConfiguration'
udmGroupId:
......@@ -2707,6 +2711,8 @@ components:
$ref: '#/components/schemas/QosMonitoringPdSupported'
qosMonitoringCongestionSupported:
$ref: '#/components/schemas/QosMonitoringCongestionSupported'
availBitRateMonSupported:
$ref: '#/components/schemas/AvailBitRateMonSupported'
pgwChangeInd:
type: boolean
enum:
......@@ -3049,6 +3055,8 @@ components:
$ref: '#/components/schemas/QosMonitoringPdSupported'
qosMonitoringCongestionSupported:
$ref: '#/components/schemas/QosMonitoringCongestionSupported'
availBitRateMonSupported:
$ref: '#/components/schemas/AvailBitRateMonSupported'
udmGroupId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId'
amfResynchedInd:
......@@ -3361,6 +3369,8 @@ components:
$ref: '#/components/schemas/QosMonitoringPdSupported'
qosMonitoringCongestionSupported:
$ref: '#/components/schemas/QosMonitoringCongestionSupported'
availBitRateMonSupported:
$ref: '#/components/schemas/AvailBitRateMonSupported'
StatusNotification:
description: Data within Notify Status Request
......@@ -3498,6 +3508,12 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara'
pduSetQosUl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSetQosPara'
dlPduSetMarkSupInd:
type: boolean
enum:
- true
multiModalId:
$ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/MultiModalId'
required:
- 5qi
......@@ -3523,6 +3539,8 @@ components:
type: array
items:
$ref: '#/components/schemas/AlternativeQosProfile'
availBitrateMonReq:
$ref: '#/components/schemas/AvailableBitrateMonitoringRequest'
required:
- maxFbrDl
- maxFbrUl
......@@ -4642,6 +4660,25 @@ components:
trafficInfluInfo:
$ref: '#/components/schemas/TrafficInfluenceInfo'
AvailableBitrateMonitoringRequest:
description: Available Bitrate Monitoring Request
type: object
properties:
availBitrateReq:
$ref: '#/components/schemas/AvailableBitrateRequest'
availBitrateUlThrs:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
minItems: 1
availBitrateDlThrs:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate'
minItems: 1
required:
- availBitrateReq
#
# SIMPLE DATA TYPES
#
......@@ -4724,12 +4761,7 @@ 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: |
User Plane Connection State. Possible values are
- ACTIVATED
- DEACTIVATED
- ACTIVATING
- SUSPENDED
description: User Plane Connection State
HoState:
anyOf:
......@@ -4745,13 +4777,7 @@ 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: |
Handover state. Possible values are
- NONE
- PREPARING
- PREPARED
- COMPLETED
- CANCELLED
description: Handover state
RequestType:
anyOf:
......@@ -4766,12 +4792,7 @@ 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: |
Request Type in Create (SM context) service operation. Possible values are
- INITIAL_REQUEST
- EXISTING_PDU_SESSION
- INITIAL_EMERGENCY_REQUEST
- EXISTING_EMERGENCY_PDU_SESSION
description: Request Type in Create (SM context) service operation
RequestIndication:
anyOf:
......@@ -4790,16 +4811,7 @@ 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: |
Request Indication in Update (SM context) service operation. Possible values are
- UE_REQ_PDU_SES_MOD
- UE_REQ_PDU_SES_REL
- PDU_SES_MOB
- NW_REQ_PDU_SES_AUTH
- NW_REQ_PDU_SES_MOD
- NW_REQ_PDU_SES_REL
- EBI_ASSIGNMENT_REQ
- REL_DUE_TO_5G_AN_REQUEST
description: Request Indication in Update (SM context) service operation
NotificationCause:
anyOf:
......@@ -4807,6 +4819,8 @@ components:
enum:
- QOS_FULFILLED
- QOS_NOT_FULFILLED
- QOS_NOT_FULFILLED_DL
- QOS_NOT_FULFILLED_UL
- UP_SEC_FULFILLED
- UP_SEC_NOT_FULFILLED
- type: string
......@@ -4814,12 +4828,7 @@ 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: |
Cause for generating a notification. Possible values are
- QOS_FULFILLED
- QOS_NOT_FULFILLED
- UP_SEC_FULFILLED
- UP_SEC_NOT_FULFILLED
description: Cause for generating a notification
Cause:
anyOf:
......@@ -4891,69 +4900,7 @@ 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: |
Cause information. Possible values are
- REL_DUE_TO_HO
- EPS_FALLBACK
- REL_DUE_TO_UP_SEC
- DNN_CONGESTION
- S_NSSAI_CONGESTION
- REL_DUE_TO_REACTIVATION
- 5G_AN_NOT_RESPONDING
- REL_DUE_TO_SLICE_NOT_AVAILABLE
- REL_DUE_TO_DUPLICATE_SESSION_ID
- PDU_SESSION_STATUS_MISMATCH
- HO_FAILURE
- INSUFFICIENT_UP_RESOURCES
- PDU_SESSION_HANDED_OVER
- PDU_SESSION_RESUMED
- CN_ASSISTED_RAN_PARAMETER_TUNING
- ISMF_CONTEXT_TRANSFER
- SMF_CONTEXT_TRANSFER
- REL_DUE_TO_PS_TO_CS_HO
- REL_DUE_TO_SUBSCRIPTION_CHANGE
- HO_CANCEL
- REL_DUE_TO_SLICE_NOT_AUTHORIZED
- PDU_SESSION_HAND_OVER_FAILURE
- DDN_FAILURE_STATUS
- REL_DUE_TO_CP_ONLY_NOT_APPLICABLE
- NOT_SUPPORTED_WITH_ISMF
- CHANGED_ANCHOR_SMF
- CHANGED_INTERMEDIATE_SMF
- TARGET_DNAI_NOTIFICATION
- REL_DUE_TO_VPLMN_QOS_FAILURE
- REL_DUE_TO_SMF_NOT_SUPPORT_PSETR
- REL_DUE_TO_SNPN_SNPN_MOBILITY
- REL_DUE_TO_NO_HR_AGREEMENT
- REL_DUE_TO_UNSPECIFIED_REASON
- REL_DUE_TO_MOB_ACCESS_RESTRICTIONS
- REL_DUE_TO_SLICE_INACTIVITY
- REL_DUE_TO_NSI_NOT_AVAILABLE
- REL_DUE_TO_SNSSAI_DENIED
- REL_DUE_TO_DNN_DENIED
- REL_DUE_TO_PDUTYPE_DENIED
- REL_DUE_TO_SSC_DENIED
- REL_DUE_TO_SUBSCRIPTION_DENIED
- REL_DUE_TO_DNN_NOT_SUPPORTED
- REL_DUE_TO_PDUTYPE_NOT_SUPPORTED
- REL_DUE_TO_SSC_NOT_SUPPORTED
- REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE
- REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN
- REL_DUE_TO_DNN_CONGESTION
- REL_DUE_TO_S_NSSAI_CONGESTION
- REL_DUE_TO_PEER_NOT_RESPONDING
- REL_DUE_TO_NETWORK_FAILURE
- REL_DUE_TO_UPF_NOT_RESPONDING
- REL_DUE_TO_NO_EPS_5GS_CONTINUITY
- REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF
- REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE
- REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE
- REL_DUE_TO_CONTEXT_NOT_FOUND
- REL_DUE_TO_MBSR_NOT_AUTHORIZED
- DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA
- REJECT_DUE_TO_N1_SM_ERROR
- REL_DUE_TO_DUPLICATE_SESSION_EPDG
- REL_DUE_TO_AF_REQUESTED_SLICE_REPLACEMENT
description: Cause information
ResourceStatus:
anyOf:
......@@ -4969,13 +4916,7 @@ 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: |
Status of SM context or PDU session resource. Possible values are
- RELEASED
- UNCHANGED
- TRANSFERRED
- UPDATED
- ALT_ANCHOR_SMF
description: Status of SM context or PDU session resource
DnnSelectionMode:
anyOf:
......@@ -4989,11 +4930,7 @@ 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: |
DNN Selection Mode. Possible values are
- VERIFIED
- UE_DNN_NOT_VERIFIED
- NW_DNN_NOT_VERIFIED
description: DNN Selection Mode
EpsInterworkingIndication:
anyOf:
......@@ -5008,12 +4945,7 @@ 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: |
EPS Interworking Indication. Possible values are
- NONE
- WITH_N26
- WITHOUT_N26
- IWK_NON_3GPP
description: EPS Interworking Indication
N2SmInfoType:
anyOf:
......@@ -5050,34 +4982,7 @@ 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: |
N2 SM Information Type. Possible values are
- PDU_RES_SETUP_REQ
- PDU_RES_SETUP_RSP
- PDU_RES_SETUP_FAIL
- PDU_RES_REL_CMD
- PDU_RES_REL_RSP
- PDU_RES_MOD_REQ
- PDU_RES_MOD_RSP
- PDU_RES_MOD_FAIL
- PDU_RES_NTY
- PDU_RES_NTY_REL
- PDU_RES_MOD_IND
- PDU_RES_MOD_CFM
- PATH_SWITCH_REQ
- PATH_SWITCH_SETUP_FAIL
- PATH_SWITCH_REQ_ACK
- PATH_SWITCH_REQ_FAIL
- HANDOVER_REQUIRED
- HANDOVER_CMD
- HANDOVER_PREP_FAIL
- HANDOVER_REQ_ACK
- HANDOVER_RES_ALLOC_FAIL
- SECONDARY_RAT_USAGE
- PDU_RES_MOD_IND_FAIL
- UE_CONTEXT_RESUME_REQ
- UE_CONTEXT_RESUME_RSP
- UE_CONTEXT_SUSPEND_REQ
description: N2 SM Information Type
MaxIntegrityProtectedDataRate:
anyOf:
......@@ -5090,10 +4995,7 @@ 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: |
Maximum Integrity Protected Data Rate. Possible values are
- 64_KBPS
- MAX_UE_RATE
description: Maximum Integrity Protected Data Rate
MaReleaseIndication:
anyOf:
......@@ -5106,10 +5008,7 @@ 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: |
Multi-Access PDU session release Indication. Possible values are
- REL_MAPDU_OVER_3GPP
- REL_MAPDU_OVER_N3GPP
description: Multi-Access PDU session release Indication
SmContextType:
anyOf:
......@@ -5123,11 +5022,7 @@ 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: |
Type of SM Context information. Possible values are
- EPS_PDN_CONNECTION
- SM_CONTEXT
- AF_COORDINATION_INFO
description: Type of SM Context information
PsaIndication:
anyOf:
......@@ -5142,12 +5037,7 @@ 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: |
Indication of whether a PSA is inserted or removed. Possible values are
- PSA_INSERTED
- PSA_REMOVED
- PSA_INSERTED_ONLY
- PSA_REMOVED_ONLY
description: Indication of whether a PSA is inserted or removed
N4MessageType:
anyOf:
......@@ -5166,16 +5056,7 @@ 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: |
N4 Message Type. Possible values are
- PFCP_SES_EST_REQ
- PFCP_SES_EST_RSP
- PFCP_SES_MOD_REQ
- PFCP_SES_MOD_RSP
- PFCP_SES_DEL_REQ
- PFCP_SES_DEL_RSP
- PFCP_SES_REP_REQ
- PFCP_SES_REP_RSP
description: N4 Message Type
QosFlowAccessType:
anyOf:
......@@ -5189,11 +5070,7 @@ 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: |
Access type associated with a QoS Flow. Possible values are
- 3GPP
- NON_3GPP
- 3GPP_AND_NON_3GPP
description: Access type associated with a QoS Flow
UnavailableAccessIndication:
anyOf:
......@@ -5206,10 +5083,7 @@ 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: |
Indicates the access type of a MA PDU session that is unavailable. Possible values are
- 3GA_UNAVAILABLE
- N3GA_UNAVAILABLE
description: Indicates the access type of a MA PDU session that is unavailable
ProtectionResult:
anyOf:
......@@ -5222,10 +5096,7 @@ 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: |
Protection Result of the security policy indicated as "preferred". Possible values are
- PERFORMED
- NOT_PERFORMED
description: Protection Result of the security policy indicated as "preferred"
QosMonitoringReq:
anyOf:
......@@ -5240,12 +5111,7 @@ 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: |
QoS monitoring request. Possible values are
- UL
- DL
- BOTH
- NONE
description: QoS monitoring request
Rsn:
anyOf:
......@@ -5259,11 +5125,7 @@ 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: |
Redundancy Sequence Number. Possible values are
- V1
- V2
- NONE
description: Redundancy Sequence Number
SmfSelectionType:
anyOf:
......@@ -5276,10 +5138,7 @@ 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: |
Smf Selection Type. Possible values are
- CURRENT_PDU_SESSION
- NEXT_PDU_SESSION
description: Smf Selection Type
PduSessionContextType:
anyOf:
......@@ -5291,9 +5150,7 @@ 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: |
Type of PDU Session information. Possible values are
- AF_COORDINATION_INFO
description: Type of PDU Session information
PendingUpdateInfo:
anyOf:
......@@ -5309,13 +5166,7 @@ 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: |
Pending Update Information. Possible values are
- UE_LOCATION
- TIMEZONE
- ACCESS_TYPE
- RAT_TYPE
- AMF_ID
description: Pending Update Information
EstablishmentRejectionCause:
anyOf:
......@@ -5327,9 +5178,7 @@ 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: |
PDU Session Establishment Rejection Cause. Possible values are
- OPERATOR_DETERMINED_BARRING
description: PDU Session Establishment Rejection Cause
EcnMarkingReq:
anyOf:
......@@ -5344,12 +5193,7 @@ 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: |
ECN Marking Request Type. Possible values are
- UL
- DL
- BOTH
- STOP
description: ECN Marking Request Type
CongestionInfoReq:
anyOf:
......@@ -5364,12 +5208,7 @@ 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: |
Congestion Information Request Type. Possible values are
- UL
- DL
- BOTH
- STOP
description: Congestion Information Request Type
ActivationStatus:
anyOf:
......@@ -5382,10 +5221,7 @@ 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: |
Activation Status. Possible values are
- ACTIVE
- NOT_ACTIVE
description: Activation Status
QosMonitoringPdSupported:
anyOf:
......@@ -5399,11 +5235,7 @@ 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: >
QoS Monitoring for packet delay supported information. Possible values are
- SUPPORTED
- NOT_SUPPORTED
- UNKNOWN
description: QoS Monitoring for packet delay supported information
QosMonitoringCongestionSupported:
anyOf:
......@@ -5417,11 +5249,37 @@ 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: QoS Monitoring for congestion supported information
AvailableBitrateRequest:
anyOf:
- type: string
enum:
- UL
- DL
- BOTH
- STOP
- type: string
description: >
QoS Monitoring for congestion supported information. Possible values are
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: Available Bitrate Monitoring Request Type
AvailBitRateMonSupported:
anyOf:
- type: string
enum:
- SUPPORTED
- NOT_SUPPORTED
- UNKNOWN
- 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: >
Available bitrate monitoring supported information.
#
# HTTP request bodies
......
TS29503_Nudm_EE.yaml
View file @ 1a359940
openapi: 3.0.0
info:
version: '1.4.0-alpha.3'
version: '1.4.0-alpha.4'
title: 'Nudm_EE'
description: |
Nudm Event Exposure Service.
......@@ -9,7 +9,7 @@ info:
All rights reserved.
externalDocs:
description: 3GPP TS 29.503 Unified Data Management Services, version 19.2.0
description: 3GPP TS 29.503 Unified Data Management Services, version 19.3.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'
servers:
......
TS29503_Nudm_MT.yaml
View file @ 1a359940
openapi: 3.0.0
info:
version: '1.3.0-alpha.1'
version: '1.3.0-alpha.2'
title: 'Nudm_MT'
description: |
UDM MT Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.503 Unified Data Management Services, version 19.0.0
description: 3GPP TS 29.503 Unified Data Management Services, version 19.3.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'
servers:
......
TS29503_Nudm_NIDDAU.yaml
View file @ 1a359940
openapi: 3.0.0
info:
version: '1.3.0-alpha.2'
version: '1.3.0-alpha.3'
title: 'Nudm_NIDDAU'
description: |
Nudm NIDD Authorization Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.503 Unified Data Management Services, version 19.1.0
description: 3GPP TS 29.503 Unified Data Management Services, version 19.3.0
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.503/'
servers:
......