Skip to content
Commits on Source (8)
Show whitespace changes
Inline Side-by-side
README.md
View file @ 1a359940
......@@ -2,7 +2,7 @@
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.
API version: **March 2025**
API version: **June 2025**
Release status: **{+ Open +}**
Other releases: [Rel-18 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-18), [Rel-17 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-17), [Rel-16 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-16), [Rel-15 (Frozen)](https://forge.3gpp.org/rep/all/5G_APIs/tree/REL-15)
......@@ -45,6 +45,11 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29572_Nlmf_DataExposure.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29572_Nlmf_DataExposure.yaml))
## SCP (Service Communication Proxy)
* Event Exposure
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29570_Nscp_EventExposure.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29570_Nscp_EventExposure.yaml))
## AMF (Access and Mobility Management Function)
* Communication
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29518_Namf_Communication.yaml))
......@@ -64,6 +69,9 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
* MBS Broadcast
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29518_Namf_MBSBroadcast.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29518_Namf_MBSBroadcast.yaml))
* Ambient IoT
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29518_Namf_AIoT.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29518_Namf_AIoT.yaml))
## SMF (Session Management Function)
* PDU Session
......@@ -306,6 +314,12 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
* Roaming Analytics
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29520_Nnwdaf_RoamingAnalytics.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29520_Nnwdaf_RoamingAnalytics.yaml))
* VFL Training
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29520_Nnwdaf_VFLTraining.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29520_Nnwdaf_VFLTraining.yaml))
* VFL Inference
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29520_Nnwdaf_VFLInference.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29520_Nnwdaf_VFLInference.yaml))
## UPF (User Plane Function)
* Event Exposure
......@@ -535,6 +549,12 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
* Media Control
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29175_Nimsas_MediaControl.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29175_Nimsas_MediaControl.yaml))
* IMS Session Management
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29175_Nimsas_ImsSessionManagement.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29175_Nimsas_ImsSessionManagement.yaml))
* IMS Event Exposure
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29175_Nimsas_ImsEE.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29175_Nimsas_ImsEE.yaml))
## MF (Media Function)
* Media Resource Management Service
......@@ -546,6 +566,16 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29570_Nscp_EventExposure.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29570_Nscp_EventExposure.yaml))
## AIOTF (Ambient IoT Function)
* Ambient IoT Service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29569_Naiotf_AIoT.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29569_Naiotf_AIoT.yaml))
## ADM (Ambient IoT Data Management Function)
* Ambient IoT Data Management Service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29369_Nadm_DM.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29369_Nadm_DM.yaml))
# Northbound and Application Layer APIs
## CAPIF (Common API Framework)
* Discover Service
......@@ -746,15 +776,21 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
* CAG Information Parameters Provisioning
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29522_CagInfoParamProvision.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29522_CagInfoParamProvision.yaml))
* UAV Flight Information Retrieval
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29522_RetrieveInfoUAVFlight.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29522_RetrieveInfoUAVFlight.yaml))
* IMS Session Management
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29522_ImsSessionManagement.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29522_ImsSessionManagement.yaml))
* IMS Event Exposure
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29522_ImsEventExposure.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29522_ImsEventExposure.yaml))
* IMS Parameters Provisioning
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29522_ImsParamProvision.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29522_ImsParamProvision.yaml))
* Ambient IoT
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29522_AIoT.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29522_AIoT.yaml))
* VFL NF Discovery
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29522_VFLNFDiscovery.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29522_VFLNFDiscovery.yaml))
## VAE (V2X Application Enabler)
* V2X Message Delivery
......@@ -945,12 +981,27 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
* ADAE AIML Member Capability Analytics
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_AIMLMemberCapabilityAnalytics.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_AIMLMemberCapabilityAnalytics.yaml))
* ADAE Server to Server Performance Analytics
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_ServerToServerPerformanceAnalytics.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_ServerToServerPerformanceAnalytics.yaml))
* ADAE UE RAT Connectivity Analytics
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_UeRatConnectivityAnalytics.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_UeRatConnectivityAnalytics.yaml))
* AADRF Data Management
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_AADRF_DataManagement.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_AADRF_DataManagement.yaml))
* ADCCF Data Collection
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADCCF_DataCollection.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADCCF_DataCollection.yaml))
* ETC Configuration
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24549_ETC_Configuration.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24549_ETC_Configuration.yaml))
* SAn Server Spatial Anchors Management Service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SAnManagement.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SAnManagement.yaml))
* SAn Server Spatial Anchors Discovery Service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SAnDiscovery.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SAnDiscovery.yaml))
## EDGEAPP (Enabling Edge Applications)
* EAS Registration
......@@ -1086,6 +1137,31 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29583_PIN_ASServiceContinuity.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29583_PIN_ASServiceContinuity.yaml))
## AIML App (Artificial Intelligence Machine Learning Application)
* AIMLE client registration service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimles_AIMLEClientRegistration.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimles_AIMLEClientRegistration.yaml))
* AIMLE server AIML task transfer service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimles_AimlTaskTransfer.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimles_AimlTaskTransfer.yaml))
* AIMLE client AIML task transfer service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimlec_AimlTaskTransfer.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimlec_AimlTaskTransfer.yaml))
* AIMLE client service operations service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimlec_AIMLEClientServiceOperations.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimlec_AIMLEClientServiceOperations.yaml))
* FL group indication service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimlec_FLGroupIndication.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimlec_FLGroupIndication.yaml))
* ML model training capability evaluation service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimlec_MLModTngCapEva.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimlec_MLModTngCapEva.yaml))
* AIMLE Context Transfer Information Service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_ContextTransfer.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_ContextTransfer.yaml))
* AIMLE Data Management Service
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_DataManagement.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_DataManagement.yaml))
# Media Delivery TS 26.510
* Common Data Types
......@@ -1296,6 +1372,9 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G
* MSAC NRM (TS 28.319)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28319_MsacNrm.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28319_MsacNrm.yaml))
* Energy Information NRM (TS 28.310)
([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS28310_EnergyInformationNrm.yaml))
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS28310_EnergyInformationNrm.yaml))
## Management Services (MnS)
* Provisioning MnS (TS 28.532)
......
TS24283_Lms_LocationInformation.yaml
View file @ 1a359940
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: LMS_LocationInformation
version: 1.0.0-alpha.2
version: 1.0.0-alpha.5
description: |
API for Requesting and subscribing on Location Information from LMS 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 24.283 V0.5.0; Mission Critical Location Management (MCLoc).
description: 3GPP TS 24.283 V1.0.0; Mission Critical Location Management (MCLoc).
url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.283/
servers:
......@@ -112,6 +112,190 @@ paths:
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/subscriptions:
post:
description: Creates a new location subscription in the LMS.
security:
- BearerAuth: []
operationId: LMSsubscriptions
tags:
- Location Subscription Request (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscriptionRequest'
responses:
'201':
description: Successful location subscription request submitted to LMS.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscriptionRequest'
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
subscriptionNotification:
'{request.body#/subscriptionResponseUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LocationNotification'
responses:
'204':
description: No Content (The receipt of the subscription notification
is acknowledged).
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29571_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
/subscriptions/{subscriptionId}:
put:
description: >
Updates an existing location subscription identified by the subscriptionId.
operationId: UpdateLocationSub
tags:
- Update Location subscription (Document)
parameters:
- name: subscriptionId
in: path
description: Identifies an individual location subscription resource.
required: true
schema:
type: string
requestBody:
description: Parameters to replace the existing subscription.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscriptionRequest'
responses:
'200':
description: >
OK. The location subcsription resource was updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationSubscriptionRequest'
'204':
description: No Content (updated successfully).
'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'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
delete:
description: >
Deletes an location subscription identified by the subscriptionId.
operationId: DeleteLocationSub
tags:
- Delete location Subscription (Document)
parameters:
- name: subscriptionId
in: path
description: Identifies an individual location subscription resource.
required: true
schema:
type: string
responses:
'204':
description: >
A location subscription resource deleted successfully.
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29571_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29571_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29571_CommonData.yaml#/components/responses/404'
'429':
$ref: 'TS29571_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
BearerAuth:
......@@ -132,6 +316,11 @@ components:
type: string
format: uri
description: A list of activated Functional Alias Id of requested MC Users.
locationNotificationUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
mclocClientID:
type: string
description: Identifies the LMC of the MC UE.
mcServiceIds:
type: array
items:
......@@ -139,15 +328,72 @@ components:
format: uri
description: A list of MC service IDs of the MC users for which
location information is requested MC Users.
mcServiceGroupIds:
type: array
items:
type: string
format: uri
description: A list of MC service Group IDs for which
location information is requested for the affiliated MC Users.
refresh:
type: boolean
nullable: true
description: The presence of this attribute indicates that the
location report shall be refreshed immediately.
requestLocationHistory:
$ref: 'TS24283_Lms_Registration.yaml#/components/schemas/RequestedLocationHistory'
requestHistoryStatus:
type: boolean
description: This attributes indicates that a location history status report is requested.
required:
- mclocClientID
- locationNotificationUri
anyOf:
- required: [functionalAliasIds]
- required: [mcServiceIds]
- required: [mcServiceGroupIds]
LocationSubscriptionRequest:
description: Represents a location subscription request.
type: object
properties:
expTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
functionalAliasIds:
type: array
items:
type: string
format: uri
description: A list of Functional Alias Id which are actived for the MC Users
for which location is subscribed.
locationNotificationUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
mclocClientID:
type: string
description: Identifies the LMC of the MC UE.
mcServiceIds:
type: array
items:
type: string
format: uri
description: A list of MC service IDs of the MC users for which
location information is subscribed MC Users.
mcServiceGroupIds:
type: array
items:
type: string
format: uri
description: A list of MC service Group IDs for which
location information is subscribed for the affiliated MC Users.
required:
- expTime
- mclocClientID
- locationNotificationUri
anyOf:
- required: [functionalAliasIds]
- required: [mcServiceIds]
- required: [mcServiceGroupIds]
MCUserLocation:
description: Represents one MC User's device location information.
......@@ -173,6 +419,9 @@ components:
when multiple MC UEs are reporting by the same MC service user.
locationInfo:
$ref: 'TS24283_Lms_LocationReport.yaml#/components/schemas/LocationInfo'
LocationNotification:
description: Represents an location notification response.
type: object
......@@ -190,3 +439,7 @@ components:
format: uri
description: The activated Functional Alias Id of the LMC that requested
the location report.
subscriptionID:
type: string
description: Attribute including the subscriptionID when the location notification
is related to an existing subscription.
TS24283_Lms_LocationReport.yaml
View file @ 1a359940
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: LMS_LocationReport
version: 1.0.0-alpha.3
version: 1.0.0-alpha.6
description: |
API for LocationReports to LMS 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 24.283 v0.5.0; Mission Critical Location Management (MCLoc).
description: 3GPP TS 24.283 v1.0.0; Mission Critical Location Management (MCLoc).
url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.283/
servers:
......@@ -105,7 +105,10 @@ components:
type: string
description: Attribute which can occur multiple times that contain the value
of the TriggerId attribute associated with a trigger that has fired.
locationHistoryData:
$ref: '#/components/schemas/LocationHistoryData'
locationHistoryStatus:
$ref: '#/components/schemas/LocationHistoryStatus'
MclocClientId:
type: string
format: uuid
......@@ -161,6 +164,53 @@ components:
anyOf:
- $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy'
LocationHistoryData:
description: This object contains one or multiple time stamped location information reports.
type: array
items:
$ref: '#/components/schemas/LocationHistoryEvent'
LocationHistoryEvent:
description: This object respresents a single location information report that has been
stored in the LMC.
type: object
properties:
locationData:
$ref: '#/components/schemas/LocationInfo'
locTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
triggerId:
type: array
items:
type: string
description: Attribute which can occur multiple times that contain the value
of the TriggerId attribute associated with a trigger that has fired.
LocationHistoryStatus:
description: This object respresents Location history summary status of the location reports
that has been stored in the LMC and has not yet been reporeted.
type: object
properties:
storedReports:
type: integer
description: set to the number of stored reports.
startTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
endTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
triggerId:
type: array
items:
type: string
description: Attribute which can occur multiple times that contain the value
of the TriggerId attribute associated with a trigger that has fired.
#
# Simple Types:
#
......
TS24283_Lms_Registration.yaml
View file @ 1a359940
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: LMS_Registration
version: 1.0.0-alpha.3
version: 1.0.0-alpha.6
description: |
API for Registration to LMS 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 24.283 V0.5.0; Mission Critical Location Management (MCLoc).
description: 3GPP TS 24.283 V1.0.0; Mission Critical Location Management (MCLoc).
url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.283/
servers:
......@@ -270,6 +270,10 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
locationRequestUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
pei:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
supi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
required:
- mclocClientID
- expTime
......@@ -295,13 +299,17 @@ components:
MC user requesting to set the location configuration.
configScope:
$ref: '#/components/schemas/ConfigScope'
historyReporting:
type: boolean
description: The attribute indicates that the LMC shall store location
information if location reporting can not be done, for example if the MC UE is out of
coverage. The stored location information can be reported at a later time.
TriggeringCriteria:
description: Contains the location reporting trigger criteria used when the
MC UE is in emergency state.
description: Contains the location reporting trigger criteria.
type: object
properties:
adaptiveTrigger:
......@@ -903,6 +911,11 @@ components:
information is being requested.
requestedLocationInfo:
$ref: '#/components/schemas/RequestedLocationInfo'
requestLocationHistory:
$ref: '#/components/schemas/RequestedLocationHistory'
requestHistoryStatus:
type: boolean
description: This attributes indicates that a location history status report is requested.
......@@ -918,3 +931,21 @@ components:
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.
RequestedLocationHistory:
description: Includes details on requested location history information
type: object
properties:
numberOfReports:
type: integer
description: Indicates the number of requested stored reports.
startTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
endTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
triggerCriteria:
$ref: '#/components/schemas/TriggeringCriteria'
minimumIntervalLength:
type: integer
description: Value in seconds, the minimum time between location reports.
TS24558_Eecs_ServiceProvisioning.yaml
View file @ 1a359940
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: Eecs_ServiceProvisioning
version: "1.2.0-alpha.2"
version: "1.2.0-alpha.3"
description: |
API for ECS Service Provisioning.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 24.558 V19.2.0 Enabling Edge Applications; Protocol specification.
description: 3GPP TS 24.558 V19.3.0 Enabling Edge Applications; Protocol specification.
url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/
security:
......@@ -146,6 +146,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ECSServProvSubscription'
'204':
description: Successful case. No Content.
'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':
......@@ -239,6 +245,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ECSServProvSubscription'
'204':
description: Successful case. No Content.
'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':
......@@ -285,6 +297,10 @@ paths:
'204':
description: >
No Content (The requested service provisioning information does not exist).
'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':
......@@ -496,7 +512,8 @@ components:
properties:
appGrpId:
type: string
description: Represents the application group that uniquely identifies
description: >
Represents the application group that uniquely identifies
the group of UEs using the same application.
easId:
type: string
......@@ -609,6 +626,12 @@ components:
minItems: 1
description: >
Indicates the authentication methods supported by the EES.
easBundleInfos:
type: array
items:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EASBundleInfo'
minItems: 1
description: List of EAS bundles to which the EAS belongs.
easBundleDetails:
type: array
items:
......@@ -635,6 +658,7 @@ components:
required:
- easId
- easBundleInfos
EesAuthMethod:
anyOf:
- type: string
......
TS24558_Eees_ACREvents.yaml
View file @ 1a359940
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: Eees_ACREvents
version: "1.1.0"
version: "1.2.0-alpha.1"
description: |
API for ACR events subscription and notification.
© 2023, 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 24.558 V18.5.1 Enabling Edge Applications; Protocol specification.
3GPP TS 24.558 V19.3.0 Enabling Edge Applications; Protocol specification.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/'
security:
......@@ -359,7 +359,9 @@ components:
- eventId
TargetInfo:
description: Details of the selected T-EAS and the T-EES.
description: >
Details of the selected T-EAS and the T-EES. The trgetEASInfo attribute shall be present,
although they are not specified as a mandatory due to backward compatibility reasons.
type: object
properties:
trgetEASInfo:
......
TS24558_Eees_AppContextRelocation.yaml
View file @ 1a359940
openapi: 3.0.0
info:
title: Eees Application Context Relocation Service
version: "1.2.0-alpha.2"
version: "1.2.0-alpha.3"
description: |
Eees Application Context Relocation Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -9,7 +9,7 @@ info:
externalDocs:
description: >
3GPP TS 24.558 V19.2.0; Enabling Edge Applications; Protocol specification; Stage 3.
3GPP TS 24.558 V19.3.0; Enabling Edge Applications; Protocol specification; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/24.558/'
servers:
......@@ -226,6 +226,16 @@ components:
items:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
minItems: 1
ueIds:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
minItems: 1
expectedLocAreas:
type: array
items:
$ref: '#/components/schemas/ExpectedLocationArea'
minItems: 1
required:
- requestorId
- tEasEndpoint
......@@ -308,7 +318,9 @@ components:
AcrModificationParams:
description: >
Represents ACR parameters specific to ACR modification request.
Represents ACR parameters specific to ACR modification request. The sEasEndpoint,
tEasEndpoint and acrParams attributes shall be present although they are not specified
as a mandatory due to backward compatibility reasons.
type: object
properties:
sEasEndpoint:
......
TS24558_Eees_EASDiscovery.yaml
View file @ 1a359940
......@@ -6,11 +6,11 @@ info:
API for EAS Discovery.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.2.0-alpha.2"
version: "1.2.0-alpha.3"
externalDocs:
description: >
3GPP TS 24.558 V19.2.0 Enabling Edge Applications; Protocol specification.
3GPP TS 24.558 V19.3.0 Enabling Edge Applications; Protocol specification.
url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/
security:
......@@ -356,8 +356,8 @@ components:
type: boolean
description: >
Indicates if the EEC requires the EAS selection support from the EES (e.g., for
constrained device). The default value false indicates the EAS selection is not
required from the EES.
constrained device). The true value indicate the EAS selection is required from the
EES. The default value false indicates the EAS selection is not required from the EES.
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
easIntTrigSup:
......@@ -462,7 +462,8 @@ components:
type: boolean
description: >
Indicates to the EES whether the application triggering is required by the EEC.
Default value false indicates the application triggering is not required.
Default value false indicates the application triggering is not required. The true value
indicate the application triggering is required.
eecTriggerPortInfo:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Port'
required:
......@@ -493,7 +494,8 @@ components:
minProperties: 1
description: >
Contains the EAS instantiation information for each discovered EAS returned within
the "discoveredEas" attribute.
the "discoveredEas" attribute. The key of the map shall be the EAS ID to which the
provided instantiation information within the map value relates.
edgeLoadAnalytics:
type: object
additionalProperties:
......@@ -543,7 +545,8 @@ components:
type: boolean
description: >
Indicates whether the content synchronization between the EASs is required. The
default value false indicates the EAS synchronization is not required.
default value false indicates the EAS synchronization is not required. The true
value indicate the EAS synchronization is required.
easProvId:
type: string
description: EAS provider identifier.
......@@ -612,33 +615,33 @@ components:
description: The application identifier of the EAS, e.g. FQDN, URI.
easStatus:
type: boolean
description: Notify if EAS status changed.
description: Notify whether the EAS status is changed or not.
easAcIds:
type: boolean
description: Notify if list of AC identifiers changed.
description: Notify whether the list of AC identifiers changed or not.
easDesc:
type: boolean
description: Notify if EAS description changed.
description: Notify whether the EAS description is changed or not.
easPt:
type: boolean
description: Notify if EAS endpoint changed.
description: Notify whether the EAS endpoint is changed or not.
easEndPoint:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
easFeature:
type: boolean
description: Notify if EAS feature changed.
description: Notify whether the EAS feature is changed or not.
easSchedule:
type: boolean
description: Notify if EAS schedule changed.
description: Notify whether the EAS schedule is changed or not.
svcArea:
type: boolean
description: Notify if EAS service area changed.
description: Notify whether the EAS service area is changed or not.
svcKpi:
type: boolean
description: Notify if EAS KPIs changed.
description: Notify whether the EAS KPIs is changed or not.
svcCont:
type: boolean
description: Notify if EAS supported ACR changed.
description: Notify whether the EAS supported ACR changed or not.
required:
- eecId
......@@ -662,7 +665,8 @@ 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: >
description: |
Represents the EAS Discovery Subscription events.
Possible values are
- EAS_AVAILABILITY_CHANGE: Represents the EAS availability change event.
- EAS_DYNAMIC_INFO_CHANGE: Represents the EAS dynamic information change event.
......@@ -723,14 +727,15 @@ components:
PredictiveData:
description: >
Contains the predictive analytics data for each discovered EAS service status
(e.g. EAS schedule, EAS status) change.
Contains the predictive analytics data for each discovered EAS service status change.
type: object
properties:
scheds:
type: array
items:
$ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime'
description: >
Indicates the schedule of the EAS.
minItems: 1
status:
type: string
......
TS24558_Eees_EASInformationProvisioning.yaml
View file @ 1a359940
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: Eees_EASInformationProvisioning
version: "1.0.0"
version: "1.1.0-alpha.1"
description: |
API for EAS Information Provisioning.
© 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 24.558 V18.5.1 Enabling Edge Applications; Protocol specification.
3GPP TS 24.558 V19.3.0 Enabling Edge Applications; Protocol specification.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/'
security:
......@@ -88,7 +88,8 @@ components:
schemas:
EASInfoProvReq:
description: Describes the parameters shared to perform EAS Information Provision related operations.
description: >
Describes the parameters shared to perform EAS Information Provision related operations.
type: object
properties:
eecId:
......@@ -102,7 +103,9 @@ components:
items:
type: string
minItems: 1
description: Indicates the identifier(s) of the selected EAS(s) for EAS bundles, which is either instantiated or instantiable..
description: >
Indicates the identifier(s) of the selected EAS(s) for EAS bundles, which is either
instantiated or instantiable.
appGrpId:
type: string
description: >
......@@ -114,6 +117,15 @@ components:
$ref: 'TS24558_Eecs_ServiceProvisioning.yaml#/components/schemas/EESInfo'
minItems: 1
description: Contains the list of EES which supports the application group identifier.
eesId:
type: string
description: Represents the identifier of the EES.
eesEndPnts:
type: array
items:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
minItems: 1
description: Represents the endpoint(s) of the EES.
reqType:
$ref: '#/components/schemas/EasInfoProvReqType'
selAcrScenarios:
......@@ -122,7 +134,7 @@ components:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'
minItems: 1
description: >
Indicates if the list of ACR scenarios are selected by the EEC.
Indicates the list of ACR scenarios selected by the EEC.
selEasEndPoints:
type: array
items:
......@@ -135,20 +147,23 @@ components:
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai'
minItems: 1
description: Represents list of Data network access identifiers for each selected EAS indetifier.
description: >
Represents list of Data network access identifiers for each selected EAS indentifier.
svcArea:
type: array
items:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
minItems: 1
description: Represents list of service are for each selected EAS indetifier.
description: >
Represents list of service area for each selected EAS indentifier.
assEesEndPoints:
type: array
items:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
minItems: 1
description: >
Indicates the endpoints of the selected EES(s) of other EES which support the direct bundled EAS within the same EDN and associated with the EASID list for EAS bundles.
Indicates the endpoints of the selected EES(s) of other EES which support the direct
bundled EAS within the same EDN and associated with the EASID list for EAS bundles.
casInfo:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
acProf:
......@@ -159,12 +174,12 @@ components:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'
minItems: 1
description: >
Indicates which ACR scenarios are supported by the EEC, if this attribute is not present, then the EEC does not support service continuity.
Indicates which ACR scenarios are supported by the EEC, if this attribute is not
present, then the EEC does not support service continuity.
required:
- eecId
- acId
- selEasIds
EASInfoProvResp:
description: Information about the EAS information provisioning response.
type: object
......@@ -184,7 +199,7 @@ components:
$ref: 'TS29558_Eees_EASRegistration.yaml#/components/schemas/EndPoint'
InstantiatedEASInfo:
description: EAS details.
description: Contains the instantiated EAS information.
type: object
properties:
eas:
......@@ -208,9 +223,11 @@ components:
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: >
description: |
Represents the type of EAS Information Provisioning Request.
Possible values are:
- ACR_SCENARIO_SELECTION_ANNOUNCEMENT: Indicates EAS information provisioning request type is ACR scenario selection announcement.
- ACR_SCENARIO_SELECTION_REQUEST: Indicates EAS information provisioning request type is ACR scenario selection request.
- ACR_SCENARIO_SELECTION_ANNOUNCEMENT: Indicates EAS information provisioning request type
is ACR scenario selection announcement.
- ACR_SCENARIO_SELECTION_REQUEST: Indicates EAS information provisioning request type is
ACR scenario selection request.
- EAS_SELECTION: Indicates EAS information provisioning request type is EAS selection.
TS24558_Eees_EECRegistration.yaml
View file @ 1a359940
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: Eees_EECRegistration
version: "1.1.0"
version: "1.2.0-alpha.1"
description: |
API for EEC registration.
© 2023, 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 24.558 V18.5.1 Enabling Edge Applications; Protocol specification.
3GPP TS 24.558 V19.3.0 Enabling Edge Applications; Protocol specification.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.558/'
security:
......@@ -77,7 +77,7 @@ paths:
operationId: UpdateIndEECReg
tags:
- Individual EEC registration (Document)
description: Update an existing EEC registration a the EES.
description: Update an existing EEC registration at the EES.
parameters:
- name: registrationId
in: path
......@@ -170,7 +170,7 @@ paths:
operationId: ModifyIndEECReg
tags:
- Individual EEC registration (Document)
description: Partially update an existing EEC registration a the EES.
description: Partially update an existing EEC registration at the EES.
parameters:
- name: registrationId
in: path
......@@ -254,7 +254,8 @@ components:
type: array
items:
$ref: 'TS29558_Eecs_EESRegistration.yaml#/components/schemas/ACRScenario'
description: Profiles of ACs for which the EEC provides edge enabling services.
description: >
The ACR scenarios supported by the EEC for service continuity.
eecCntxId:
type: string
description: Identifier of the EEC context obtained from a previous registration.
......@@ -281,6 +282,7 @@ components:
type: array
items:
$ref: 'TS24558_Eees_EASDiscovery.yaml#/components/schemas/DiscoveredEas'
description: List of discovered EAS(s) information.
minItems: 1
unfulfillAcProfs:
type: array
......@@ -298,7 +300,9 @@ components:
- eecId
ACProfile:
description: AC information indicating required services and service characteristics.
description: >
Describes information about AC used to determine required services and service
characteristics.
type: object
properties:
acId:
......@@ -399,7 +403,9 @@ components:
$ref: '#/components/schemas/DeviceType'
UnfulfilledAcProfile:
description: Describes AC Profile ID and reason sent by EES in EEC Register response.
description: >
Describes AC Profile ID and reason why requirements indicated in the AC
profile cannot be fulfilled.
type: object
properties:
acId:
......@@ -420,10 +426,10 @@ components:
enumeration and is not used to encode content defined in the present version
of this API.
description: |
Represents reason for unfulfilled AC profile requirements.
Represents the reasons for unfulfilled AC profile requirements.
Possible values are:
- EAS_NOT_AVAILABLE: EAS is not available.
- REQ_UNFULFILLED: Requirements cannot be fulfilled.
- EAS_NOT_AVAILABLE: Indicates the EAS is not available.
- REQ_UNFULFILLED: Indicates the requirements cannot be fulfilled.
DeviceType:
anyOf:
......@@ -436,8 +442,8 @@ components:
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 UE type.
description: |
Represents the devices characteristics of UE.
Possible values are:
- CONSTRAINED_UE: Indicates UE is constrained with resources like power, processor etc.
- NORMAL_UE: Indicates UE is not constrained with resources.
- CONSTRAINED_UE: Indicates the UE is constrained with resources.
- NORMAL_UE: Indicates the UE is not constrained with resources.
TS24559_ADAE_ServiceConfiguration.yaml
View file @ 1a359940
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: ADAE_ServiceConfiguration
version: 1.1.0-alpha.2
version: 1.1.0-alpha.3
description: |
API for ADAE service configuration.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 24.559 V19.1.0 Application Data Analytics Enablement Service; Stage 3.
3GPP TS 24.559 V19.2.0 Application Data Analytics Enablement Service; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/24_series/24.559/
security:
......@@ -683,6 +683,7 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
required:
- serverId
- analyticsId
- valUeIds
- pc5Qos
......
TS24560_Aimlec_AIMLEClientServiceOperations.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: Aimlec_AIMLEClientServiceOperations
version: 1.0.0-alpha.1
description: |
API for AIMLE Client Service Operations Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 24.560 V1.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service
Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/'
servers:
- url: '{apiRoot}/aimlec-serv-ops/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/perform:
post:
summary: >
Enables the AIMLE server to request the AIMLE client to perform the AIMLE client
service operation.
operationId: AimleServOperReq
tags:
- AIMLE service operation request
requestBody:
description: Contains the AIMLE client service operation request information.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AimleClientServOpReq'
responses:
'200':
description: Contains the AIMLE client service operation response information.
content:
application/json:
schema:
$ref: '#/components/schemas/AimleClientServOpResp'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
# Structured data types
AimleClientServOpReq:
description: Contains the AIMLE client service operation request information.
type: object
required:
- aimleServerId
- servOpId
- servOpMode
properties:
aimleServerId:
description: Represents the AIMLE server identifier.
type: string
valServiceId:
description: Represents the VAL service identifier.
type: string
servOpId:
description: Represents the AIML service operation identifier.
type: string
servOpMode:
$ref: '#/components/schemas/ServiceOperationMode'
servOpInfo:
$ref: '#/components/schemas/ServiceOperationInfo'
servOpModeCfg:
$ref: '#/components/schemas/ServiceOpModeConfiguration'
servOpModeStatRptg:
$ref: 'TS29549_SS_NetworkResourceMonitoring.yaml#/components/schemas/ReportingRequirements'
AimleClientServOpResp:
description: Contains the AIMLE client service operation response information.
type: object
required:
- servOpId
- servOpModeStatus
properties:
valServiceId:
description: Represents the VAL service identifier.
type: string
servOpId:
description: Represents the AIML service operation identifier.
type: string
servOpModeStatus:
$ref: '#/components/schemas/ServiceOperationMode'
ServiceOperationInfo:
description: Contains the AIML service operation information.
type: object
properties:
mlMdlContainer:
description: Represents the AIML service model container.
type: string
mlMdlUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
mlMdAggregUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
maxConvgTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
ServiceOpModeConfiguration:
description: Contains the AIML service operation mode configuration.
type: object
properties:
maxLatency:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
maxDurHour:
description: >
Indicates the maximum duration time of the AIML service operation expressed in hours.
type: integer
modelAccuracy:
description: >
Indicates the threshold value of the model accuracy expressed as a percentage to
stop the AIML service operation.
type: integer
# Simple data types
# Enumerations
ServiceOperationMode:
anyOf:
- type: string
enum:
- START
- STOP
- 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 AIMLE service operation modes.
Possible values are:
- START: Indicates a request to start the AIMLE service operation or status of the AIMLE
service operation.
- STOP: Indicates a request to stop the AIMLE service operation or status of the AIMLE
service operation.
TS24560_Aimlec_AimlTaskTransfer.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: Aimlec_AimlTaskTransfer
version: 1.0.0-alpha.1
description: |
API for AIMLE Client AIML Task Transfer Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 24.560 V1.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service
Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/'
servers:
- url: '{apiRoot}/aimlec-task-transfer/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/request:
post:
summary: Enables the AIMLE server to request the AIMLE client to perform AIML task transfer.
operationId: AimlTaskTransf
tags:
- AIML task transfer
requestBody:
description: Contains the AIMLE client task transfer request information.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AimleClientTaskTransferReq'
responses:
'200':
description: Contains the AIMLE client task transfer response information.
content:
application/json:
schema:
$ref: '#/components/schemas/AimleClientTaskTransferRes'
'204':
description: No Content. The AIMLE client AIML task transfer is performed.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/request-direct:
post:
summary: >
Enables the AIMLE client to request the target AIMLE client to perform AIML task transfer.
operationId: DirAimlTaskTransf
tags:
- Direct AIML task transfer
requestBody:
description: Contains the AIMLE client direct task transfer request information.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AimleClientDirectTransferReq'
responses:
'204':
description: No Content. The AIMLE client direct AIML task transfer is performed.
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
# Structured data types
AimleClientTaskTransferReq:
description: Contains the AIMLE client task transfer request information.
type: object
required:
- requestorId
- sourceAimlId
- aimlTaskType
- aimlInfoType
properties:
requestorId:
description: Represents the identifier of the AIMLE server.
type: string
sourceAimlId:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
aimlTaskType:
$ref: 'TS24560_Aimles_AIMLEClientRegistration.yaml#/components/schemas/AimlOperation'
aimlInfoType:
$ref: '#/components/schemas/AimlInfoType'
aimlTaskTransferTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
AimleClientTaskTransferRes:
description: Contains the AIMLE client task transfer response information.
type: object
properties:
aimlTaskTransferTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
AimleClientDirectTransferReq:
description: Contains the AIMLE client direct task transfer request information.
type: object
required:
- requestorId
- aimlTaskType
- aimlInfoType
properties:
requestorId:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
aimlTaskType:
$ref: 'TS24560_Aimles_AIMLEClientRegistration.yaml#/components/schemas/AimlOperation'
aimlInfoType:
$ref: '#/components/schemas/AimlInfoType'
aimlTaskTransferTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
# Simple data types
# Enumerations
AimlInfoType:
anyOf:
- type: string
enum:
- INTERMEDIATE_AIML_OP_RESULTS
- INTERMEDIATE_AIML_OP_STATUS
- FIRST_MATCH
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
but is not used to encode content defined in the present version of this API.
description: |
Represents the type of the AIML Information.
Possible values are:
- INTERMEDIATE_AIML_OP_RESULTS: Indicates the intermediate AIML operation results type
of the AIML information.
- INTERMEDIATE_AIML_OP_STATUS: Indicates the intermediate AIML operation status type of
the AIML information.
- OTHER_AIML_INFO_TYPE: Indicates other types of the AIML information.
TS24560_Aimlec_FLGroupIndication.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: Aimlec_FLGroupIndication
version: 1.0.0-alpha.4
description: |
API for AIMLE Client Federated Learning Group Indication Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 24.560 V1.0.0; Artificial Intelligence Machine Learning (AIML) Services –
Service enabler Architecture Layer for Verticals (SEAL) Protocol Specification; Stage 3.
url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.560/
servers:
- url: '{apiRoot}/aimlec-flgi/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122
security:
- {}
- oAuth2ClientCredentials: []
paths:
/indicate:
post:
summary: Indicates FL group information to FL group member
operationId: IndicateFLMemberInfo
tags:
- Indicate FL group
requestBody:
description: Contains the FL group member information.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/IndFlMember'
responses:
'204':
description: No Content (Success)
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
# Structured data types
IndFlMember:
description: Indicates the FL member the information on FL member group.
type: object
properties:
serverId:
type: string
description: Identifier of the indicating AIMLE server.
valServiceId:
type: string
description: Identifier of the VAL service for which the grouping indication is applied.
mlModelId:
type: string
description: Identifier of the ML model for which the grouping indication is applied.
analyticsId:
type: string
description: >
Identifier of the ADAE analytics service, the FL grouping is based on, if
the FL process is used for that ADAE analytics service.
flGroupIds:
type: array
items:
$ref: '#/components/schemas/FlGroupInfo'
minItems: 1
description: >
List of the AIMLE identifiers of that created or changed FL group for the FL process.
flGroupDelInfo:
$ref: '#/components/schemas/FlGroupDeletionInfo'
required:
- serverId
- flGroupIds
FlGroupInfo:
description: Represents the FL group information.
type: object
required:
- flGroupId
properties:
flGroupId:
description: Contains the FL group identifier.
type: string
flMembers:
type: array
items:
$ref: '#/components/schemas/FlMemberData'
minItems: 1
description: Contains FL member data.
FlMemberData:
description: Represents the FL group member data e.g. FL member identifier, address.
type: object
properties:
flMemberId:
type: string
description: Identifier of the FL member.
flMemberAddr:
$ref: 'TS29549_SS_NetworkResourceAdaptation.yaml#/components/schemas/ValUeAddrInfo'
flMemberInfo:
$ref: '#/components/schemas/FlMemberInfo'
FlMemberInfo:
description: Represents the FL member information e.g. availability, constraint, FL role.
type: object
properties:
availability:
$ref: '#/components/schemas/FlMemberAvailability'
constraints:
description: Represents the FL group member constraints.
type: array
items:
$ref: '#/components/schemas/FlMemberConstraint'
minItems: 1
role:
$ref: '#/components/schemas/FlMemberRole'
FlGroupDeletionInfo:
description: Indicates the FL group deletion information.
type: object
properties:
cause:
description: Represents the cause for the FL group deletion.
type: string
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
# Simple data types
# Enumerations
FlMemberAvailability:
anyOf:
- type: string
enum:
- AVAILABLE
- STOP
- 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 information regarding FL member availability of the VAL UE.
Possible values are:
- AVAILABLE: The FL member is available.
- NOT_AVAILABLE: The FL member is not available.
FlMemberConstraint:
anyOf:
- type: string
enum:
- LOW_BATTERY_LEVEL
- HIGH_MEMORY_LOAD
- 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 FL member constraint information of the VAL UE.
Possible values are:
- LOW_BATTERY_LEVEL: Indicates a low battery level.
- HIGH_MEMORY_LOAD: Indicates a high memory load.
FlMemberRole:
anyOf:
- type: string
enum:
- FL_CLIENT
- FL_SERVER
- FL_AGGREGATOR
- 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 FL member role of the VAL UE.
Possible values are:
- FL_CLIENT: Indicates an FL client role.
- FL_SERVER: Indicates an FL server role.
- FL_AGGREGATOR: Indicates an FL aggregator role.
TS24560_Aimlec_MLModTngCapEva.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: Aimlec_MLModelTrainingCapabilityEva
version: 1.0.0-alpha.1
description: |
API for ML Model Training Capability Evaluation Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 24.560 V1.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service
Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/'
servers:
- url: '{apiRoot}/aimlec-ml-mtce/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/request:
post:
summary: >
Enables the AIMLE server to request the AIMLE client to perform ML model training
capability evaluation service operation.
operationId: MlModTrainCapEvaReq
tags:
- ML model training capability evaluation request
requestBody:
description: Contains the ML model training capability evaluation request information.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MlModTngCapEvalReq'
responses:
'200':
description: Contains the ML model training capability evaluation response information.
content:
application/json:
schema:
$ref: '#/components/schemas/MlModTngCapEvalResp'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
# Structured data types
MlModTngCapEvalReq:
description: Contains the ML model training capability evaluation request information.
type: object
required:
- aimleServerId
properties:
aimleServerId:
description: Represents the AIMLE server identifier.
type: string
availTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
testTask:
description: Represents the task for test ML model training capability.
type: string
modelInfo:
$ref: '#/components/schemas/AimlModelData'
dataSetReq:
$ref: '#/components/schemas/DataSetRequirements'
MlModTngCapEvalResp:
description: Contains the ML model training capability evaluation response information.
type: object
required:
- capEvalOut
properties:
capEvalOut:
$ref: '#/components/schemas/CapEvalOutcome'
testResult:
description: Represents the test result of the ML model training capability evaluation.
type: string
evalFailInd:
description: Represents the reason for inability to join the FL training process.
type: string
AimlModelData:
description: Contains the AIML model information and model parameters for use in FL training.
type: object
properties:
aimlModels:
description: Contains information about the AIML model.
type: array
items:
$ref: '#/components/schemas/AimlModelInfo'
minItems: 1
mlModelParams:
description: Contains model parameters for use in FL training.
type: array
items:
type: string
minItems: 1
DataSetRequirements:
description: Contains requirements on data set for FL training.
type: object
properties:
commonFtIds:
description: >
Contains a list of the features identifiers of the required features common to
the dataset of the different data domains.
type: array
items:
type: string
minItems: 1
domainFts:
description: >
Contains a list of features for each data domain(s) of the datasets at the UE.
type: array
items:
$ref: '#/components/schemas/DomainFeatures'
minItems: 1
dataSource:
description: >
Represents the identifier of a data source for the FL training (e.g. SEAL server,
SEAL client, other NF entity, etc.).
type: string
DomainFeatures:
description: Contains a list of features for each data domain(s) of the datasets at the UE.
type: object
required:
- domain
- featureIds
properties:
domain:
description: >
Represents a data domain i.e. a specific category of data or logical groupings of
data that all relate together (e.g. customer data, product data, etc.).
type: string
featureIds:
description: >
Represents a list of the features identifiers for the data domain of the datasets
at the UE.
type: array
items:
type: string
minItems: 1
AimlModelInfo:
description: Contains information about the AIML model.
type: object
properties:
aimlModelTypes:
$ref: 'TS24560_Aimles_AIMLEClientRegistration.yaml#/components/schemas/AimlModelType'
mlModelProf:
$ref: '#/components/schemas/MlModelProfile'
# Simple data types
MlModelProfile:
description: Temporary definition since MlModelProfile is not yet specified in 29.482.
type: string
# Enumerations
CapEvalOutcome:
anyOf:
- type: string
enum:
- ABILITY_TO_JOIN
- FIRST_MATCH
- 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 outcome of the ML model training capability evaluation.
Possible values are:
- ABILITY_TO_JOIN: Indicates ability to join the training process.
- INABILITY_TO_JOIN: Indicates inability to join the training process.
TS24560_Aimles_AIMLEClientRegistration.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: Aimles_AIMLEClientRegistration
version: 1.0.0-alpha.1
description: |
API for AIMLE Client Registration Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 24.560 V1.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service
Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/'
servers:
- url: '{apiRoot}/aimles-client-reg/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/registrations:
post:
summary: Registers the AIMLE client at the AIMLE server.
operationId: RegAimleClient
tags:
- AIMLE client registrations
requestBody:
description: >
Contains information for the creation of a new individual AIMLE client registration
resource.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AimleClientRegInfo'
responses:
'201':
description: Represents an individual AIMLE client registration resource.
content:
application/json:
schema:
$ref: '#/components/schemas/AimleRegistration'
headers:
Location:
description: >
Contains the URI of the newly created individual AIMLE client registration
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'
/registrations/{registrationId}:
put:
summary: Update an Individual AIMLE client registration resource.
operationId: UpdateAimleClientReg
tags:
- Individual AIMLE client registration (Document)
parameters:
- name: registrationId
description: >
String identifying the individual AIMLE client registration resource at the AIMLE server.
in: path
required: true
schema:
type: string
requestBody:
description: >
Contains information for the update of individual AIMLE client registration resource.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AimleRegistration'
responses:
'200':
description: >
An individual AIMLE client registration resource is updated, and a representation of
that resource is returned.
content:
application/json:
schema:
$ref: '#/components/schemas/AimleRegistration'
'204':
description: No Content. An individual AIMLE client registration resource is updated.
'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: Removes an Individual AIMLE client registration resource.
operationId: DelAimleClientReg
tags:
- Individual AIMLE client registration (Document)
parameters:
- name: registrationId
description: >
String identifying the individual AIMLE client registration resource at the AIMLE server.
in: path
required: true
schema:
type: string
responses:
'204':
description: An individual AIMLE client registration resource is removed.
'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
AimleRegistration:
description: Represents an individual AIMLE client registration resource.
type: object
required:
- regData
properties:
regData:
$ref: '#/components/schemas/AimleClientRegInfo'
expTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
AimleClientRegInfo:
description: Contains the AIMLE client registration information.
type: object
required:
- aimleClientId
- suppProfiles
properties:
aimleClientId:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
suppProfiles:
description: Contains a list of supported service information and AIML client profiles.
type: array
items:
$ref: '#/components/schemas/SupportedProfile'
minItems: 1
suppFeat:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
SupportedProfile:
description: Contains AIMLE client profiles and supported service information.
type: object
properties:
clientProfile:
$ref: '#/components/schemas/AimleClientProfile'
suppServices:
description: >
Contains the list of VAL services identifiers with corresponding service permissions.
type: array
items:
$ref: '#/components/schemas/ServiceData'
minItems: 1
ServiceData:
description: Contains VAL service identifier with the corresponding service permission.
type: object
required:
- valServiceId
properties:
valServiceId:
description: Represents the VAL service identifier.
type: string
servPermLevel:
$ref: '#/components/schemas/ServicePermissionLevel'
AimleClientProfile:
description: >
Contains the AIMLE client capability information e.g. supported AIML model types,
AIML service operation type.
type: object
required:
- aimleClientUri
- aimlOperations
- clientCap
properties:
aimleClientUri:
$ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
aimlModelTypes:
description: Contains AIML model types supported by the AIMLE client.
type: array
items:
$ref: '#/components/schemas/AimlModelType'
minItems: 1
aimlOperations:
description: Contains AIML operations supported by the AIMLE client.
type: array
items:
$ref: '#/components/schemas/AimlOperation'
minItems: 1
clientCap:
$ref: '#/components/schemas/ClientCapability'
availTimeSchedCfgs:
description: >
Contains the availability schedule of the AIMLE client for the AIML service.
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime'
minItems: 1
unavblTimeSchedCfgs:
description: >
Contains the unavailability schedule of the AIMLE client for the AIML service.
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ScheduledCommunicationTime'
minItems: 1
availLocCfgs:
description: >
Contains the available location-based configurations of the AIMLE client for the
AIML service.
type: array
items:
$ref: '#/components/schemas/LocationConfig'
minItems: 1
unavblLocCfgs:
description: >
Contains the unavailable location-based configurations of the AIMLE client for the
AIML service.
type: array
items:
$ref: '#/components/schemas/LocationConfig'
minItems: 1
dataSetAvail:
$ref: '#/components/schemas/DataSetAvailability'
dataCap:
description: >
Contains a list of data capabilities such as the type of data that can be collected,
supported data processing capabilities and supported exploratory data analysis (EAD)
functions.
type: array
items:
$ref: '#/components/schemas/DataCapability'
minItems: 1
taskCaps:
description: Contains the AIML task performing capabilities.
type: array
items:
$ref: '#/components/schemas/TaskCapability'
minItems: 1
ClientCapability:
description: Contains the AIMLE client capability information.
type: object
required:
- mlAppType
- rsrcUsageLvl
properties:
mlAppType:
$ref: '#/components/schemas/MlApplicationType'
rsrcUsageLvl:
$ref: '#/components/schemas/ResourceUsageLevel'
DataSetAvailability:
description: Represents a dataset availability.
type: object
required:
- dataSetIds
properties:
dataSetIds:
description: Contains a list of dataset identifiers.
type: array
items:
type: string
minItems: 1
size:
description: Represents the dataset size e.g., number of entries in dataset.
type: integer
age:
description: Represents the dataset age e.g. data set usage in number of days.
type: integer
features:
description: Contains a list of dataset features.
type: array
items:
type: string
minItems: 1
LocationConfig:
description: >
Indicates the location-based configurations of the AIMLE client for the AIML service.
type: object
properties:
clientLoc:
$ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G'
valSvcAreaId:
$ref: 'TS29549_SS_VALServiceAreaConfiguration.yaml#/components/schemas/ValSvcAreaId'
# Simple data types
# Enumerations
ServicePermissionLevel:
anyOf:
- type: string
enum:
- PREMIUM_RESOURCE_USAGE
- STANDARD_RESOURCE_USAGE
- LIMITED_RESOURCE_USAGE
- OTHER_SERVICE_PERMISSION_LEVEL
- 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 a service permission level.
Possible values are:
- PREMIUM_RESOURCE_USAGE: Indicates a premium resource usage level.
- STANDARD_RESOURCE_USAGE: Indicates a standard resource usage level.
- LIMITED_RESOURCE_USAGE: Indicates a limited resource usage level.
- OTHER_SERVICE_PERMISSION_LEVEL: Indicates other service permission level.
AimlModelType:
anyOf:
- type: string
enum:
- DECISION_TREE
- LINEAR_REGRESSION
- NEURAL_NETWORK
- OTHER_MODEL_TYPE
- 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 AIML model types.
Possible values are:
- DECISION_TREE: Indicates the decision tree type of the AIML model.
- LINEAR_REGRESSION: Indicates the linear regression type of the AIML model.
- NEURAL_NETWORK: Indicates the neural network type of the AIML model.
- OTHER_MODEL_TYPE: Indicates the other types of the AIML model.
AimlOperation:
anyOf:
- type: string
enum:
- MODEL_INFERENCE
- MODEL_OFFLOAD
- MODEL_SPLIT
- MODEL_TRANSFER
- MODEL_TRAINING
- type: string
description: >
This string provides forward-compatibility with future extensions to the enumeration
but is not used to encode content defined in the present version of this API.
description: |
Represents the type of the AIML operation.
Possible values are:
- MODEL_INFERENCE: Indicates the model inference type of the AIML operation.
- MODEL_OFFLOAD: Indicates the model offload type of the AIML operation.
- MODEL_SPLIT: Indicates the model split type of the AIML operation.
- MODEL_TRANSFER: Indicates the model transfer type of the AIML operation.
- MODEL_TRAINING: Indicates the model training type of the AIML operation.
MlApplicationType:
anyOf:
- type: string
enum:
- FEDERATED_LEARNING
- TRANSFER_LEARNING
- SPLIT_LEARNING
- OTHER_ML_APPLICATION_TYPE
- 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 ML application types.
Possible values are:
- FEDERATED_LEARNING: Indicates the federated learning ML application type.
- TRANSFER_LEARNING: Indicates the transfer learning ML application type.
- SPLIT_LEARNING: Indicates the split learning ML application type.
- OTHER_ML_APPLICATION_TYPE: Indicates the other ML application types.
ResourceUsageLevel:
anyOf:
- type: string
enum:
- PREMIUM_RESOURCE_USAGE
- STANDARD_RESOURCE_USAGE
- LIMITED_RESOURCE_USAGE
- 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 a resource usage level.
Possible values are:
- PREMIUM_RESOURCE_USAGE: Indicates a premium resource usage level.
- STANDARD_RESOURCE_USAGE: Indicates a standard resource usage level.
- LIMITED_RESOURCE_USAGE: Indicates a limited resource usage level.
DataCapability:
anyOf:
- type: string
enum:
- RAW_DATA
- STRUCURED_DATA
- SEMI_STRUCTURED_DATA
- UNSTRUCTURED_DATA
- PROCESSED_DATA
- EXPLOATORY_DATA_ANALYSIS
- 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 data capabilities.
Possible values are:
- RAW_DATA: Indicates the raw data.
- STRUCURED_DATA: Indicates the structured data.
- SEMI_STRUCTURED_DATA: Indicates the semi-structured data.
- UNSTRUCTURED_DATA: Indicates the unstructured data.
- PROCESSED_DATA: Indicates the processed data.
- EXPLOATORY_DATA_ANALYSIS: Indicates the exploratory data analysis function.
match.
TaskCapability:
anyOf:
- type: string
enum:
- HIGH_COMPUTE_CAPABILITY
- LOW_COMPUTE_CAPABILITY
- LOW_COSTS_PERFORMANCE
- GREEN_TASK_PERFORMANCE
- ENERGY_EFFICIENT_PERFORMANCE
- 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 AIML task performing capabilities.
Possible values are:
- HIGH_COMPUTE_CAPABILITY: Indicates a high compute capability.
- LOW_COMPUTE_CAPABILITY: Indicates a low compute capability.
- LOW_COSTS_PERFORMANCE: Indicates a low cost performance.
- GREEN_TASK_PERFORMANCE: Indicates a green task performance.
- ENERGY_EFFICIENT_PERFORMANCE: Indicates an energy efficient performance.
TS24560_Aimles_AimlTaskTransfer.yaml 0 → 100644
View file @ 1a359940
openapi: 3.0.0
info:
title: Aimles_AimlTaskTransfer
version: 1.0.0-alpha.1
description: |
API for AIMLE Server AIML Task Transfer Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 24.560 V1.0.0; Artificial Intelligence Machine Learning (AIML) Services – Service
Enabler Architecture Layer for Verticals (SEAL); Protocol Specification; Stage 3.
url: 'https://www.3gpp.org/ftp/Specs/archive/24_series/24.560/'
servers:
- url: '{apiRoot}/aimles-task-transfer/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
security:
- {}
- oAuth2ClientCredentials: []
paths:
/assist-tt:
post:
summary: >
Enables the AIMLE client to request the AIMLE server to perform task transfer assist.
operationId: AimlTtAssist
tags:
- AIML task transfer assist
requestBody:
description: Contains the AIMLE server task transfer assist request information.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AimlesTaskTransferAssistReq'
responses:
'200':
description: Contains the AIMLE server task transfer assist response information.
content:
application/json:
schema:
$ref: '#/components/schemas/AimlesTaskTransferAssistResp'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
/request-ctld:
post:
summary: >
Enables the AIMLE client to request the AIMLE server to perform AIMLE server controlled
task transfer.
operationId: CtldAimlTt
tags:
- Controlled AIML task transfer
requestBody:
description: Contains the AIMLE server controlled task transfer request information.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AimlesControlledTaskTransferReq'
responses:
'200':
description: Contains the AIMLE server controlled task transfer response information.
content:
application/json:
schema:
$ref: '#/components/schemas/AimlesControlledTaskTransferResp'
'307':
$ref: 'TS29122_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29122_CommonData.yaml#/components/responses/308'
'400':
$ref: 'TS29122_CommonData.yaml#/components/responses/400'
'401':
$ref: 'TS29122_CommonData.yaml#/components/responses/401'
'403':
$ref: 'TS29122_CommonData.yaml#/components/responses/403'
'404':
$ref: 'TS29122_CommonData.yaml#/components/responses/404'
'411':
$ref: 'TS29122_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29122_CommonData.yaml#/components/responses/413'
'415':
$ref: 'TS29122_CommonData.yaml#/components/responses/415'
'429':
$ref: 'TS29122_CommonData.yaml#/components/responses/429'
'500':
$ref: 'TS29122_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29122_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29122_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{tokenUrl}'
scopes: {}
schemas:
# Structured data types
AimlesTaskTransferAssistReq:
description: Contains the AIMLE server task transfer assist request information.
type: object
required:
- requestorId
- aimlTaskType
- aimlInfoType
properties:
requestorId:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
valServiceId:
description: >
Represents identifier of the VAL service for which the assistance information
is requested.
type: string
aimlTaskType:
$ref: 'TS24560_Aimles_AIMLEClientRegistration.yaml#/components/schemas/AimlOperation'
aimlInfoType:
$ref: 'TS24560_Aimlec_AimlTaskTransfer.yaml#/components/schemas/AimlInfoType'
aimlRmngTrainReq:
$ref: '#/components/schemas/AimlRmngTrainingReq'
aimlImdInfo:
$ref: '#/components/schemas/AimlIntermediateInfo'
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
AimlesTaskTransferAssistResp:
description: Contains the AIMLE server task transfer assist response information.
type: object
required:
- assistanceTime
- targetAimlIds
properties:
assistanceTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
targetAimlIds:
description: List of the target AIMLE clients.
type: array
items:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
minItems: 1
transferMode:
$ref: '#/components/schemas/TransferMode'
AimlesControlledTaskTransferReq:
description: Contains the AIMLE server controlled task transfer request information.
type: object
required:
- requestorId
- aimlTaskType
- aimlInfoType
- aimlTaskTransferTime
properties:
requestorId:
$ref: 'TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe'
aimlTaskType:
$ref: 'TS24560_Aimles_AIMLEClientRegistration.yaml#/components/schemas/AimlOperation'
aimlInfoType:
$ref: 'TS24560_Aimlec_AimlTaskTransfer.yaml#/components/schemas/AimlInfoType'
aimlTaskTransferTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
timeValidity:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
AimlesControlledTaskTransferResp:
description: Contains the AIMLE server controlled task transfer response information.
type: object
required:
- assistanceTime
properties:
assistanceTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
AimlRmngTrainingReq:
description: Contains requirements for AIML model training.
type: object
properties:
reqRmngTrainResorce:
description: Indicates required remaining training resource.
type: string
reqRmngTrainIterNum:
description: Indicates required remaining training number of iterations.
type: integer
AimlIntermediateInfo:
description: Contains the AIML intermediate information for intermediate AIML operation.
type: object
properties:
aimlImdModel:
$ref: '#/components/schemas/AimlRmngTrainingReq'
aimlUsedTrainTime:
$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'
usedTrainResource:
description: Indicates used training resource.
type: string
usedTrainIterNum:
description: Indicates used training number of iterations.
type: integer
# Simple data types
# Enumerations
TransferMode:
anyOf:
- type: string
enum:
- DIRECT
- SERVER_CONTROLLED
- 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 mode of transfer.
Possible values are:
- DIRECT: Directly from the source AIML member to the target AIML member.
- SERVER_CONTROLLED: Transfer with AIMLE server controlled.
TS26247_QualityReportingSchemeInformation.xsd
View file @ 1a359940
......@@ -38,12 +38,17 @@
</xs:simpleType>
<xs:simpleType name="CommunicationServiceTypeType">
<xs:restriction base="xs:string">
<xs:list>
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="all" />
<xs:enumeration value="unicast" />
<xs:enumeration value="mbsBroadcast" />
<xs:enumeration value="mbsMulticast" />
</xs:restriction>
</xs:simpleType>
</xs:list>
</xs:simpleType>
<xs:complexType name="LocationFilterType">
<xs:sequence>
......
TS26510_CommonData.yaml
View file @ 1a359940
openapi: 3.0.0
info:
title: 'Media Delivery: Common Data Types'
version: 1.0.1
version: 1.0.2
description: |
Media Delivery: Common Data Types
© 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.
tags:
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Common Data Types'
externalDocs:
description: 'TS 26.510 V18.1.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.4.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
paths: {}
......
TS26510_Maf_Provisioning_ConsumptionReporting.yaml
View file @ 1a359940
openapi: 3.0.0
info:
title: Maf_Provisioning_ConsumptionReporting
version: 1.0.0
version: 1.0.1
description: |
Media Delivery: Consumption Reporting Provisioning API
© 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.
tags:
......@@ -12,7 +12,7 @@ tags:
description: 'Media Delivery: Consumption Reporting Provisioning API'
externalDocs:
description: 'TS 26.510 V18.0.0; Media Delivery; Interactions and APIs for media session handling'
description: 'TS 26.510 V18.4.0; Media Delivery; Interactions and APIs for media session handling'
url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.510/'
servers:
......