Commit eed71032 authored by bradburyr's avatar bradburyr
Browse files

CR26264-CR0007r2 [S4-252049|SP-251437] as supplied by Imed Bouazizi (Qualcomm) on 2025-12-05.

parent b849607b

README.md

100644 → 100755
+116 −7
Original line number Diff line number Diff line 
# OpenAPI Specification Files for 3GPP 5G Core Network (Release 19)

# {-[DRAFT]-} OpenAPI Specification Files for 3GPP 5G Core Network (Release 19)



© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved.



API version: **September 2025**  

API version: **October/November 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)



OpenAPI validation status:

[![pipeline status](https://forge.3gpp.org/rep/all/5G_APIs/badges/REL-19/pipeline.svg)](https://forge.3gpp.org/rep/all/5G_APIs/commits/REL-19)

[![pipeline status](https://forge.3gpp.org/rep/all/5G_APIs/badges/Rel19-draft-TSG110/pipeline.svg)](https://forge.3gpp.org/rep/all/5G_APIs/commits/Rel19-draft-TSG110)



#### Tools

* <a href="https://forge.3gpp.org/swagger/tools/parser.html">API Parser/Linter</a> to parse OpenAPI files with APIDevTools Swagger Parser/Validator and run a number of <a href="https://en.wikipedia.org/wiki/Lint_(software)" target="_blank">lint</a> rules to improve API quality
@@ -260,6 +260,12 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 
* VFL Inference

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29591_Nnef_VFLInference.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29591_Nnef_VFLInference.yaml))

* Training

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29591_Nnef_Training.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29591_TS29591_Nnef_Training.yaml))

* VFL Training

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29591_Nnef_VFLTraining.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29591_Nnef_VFLTraining.yaml))



## PCF (Policy Control Function)

* Policy Authorization
@@ -597,6 +603,14 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f 
* 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))

* Ambient IoT Security Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29369_Nadm_Sec.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29369_Nadm_Sec.yaml))



## EIF (Energy Information Function)

* EIF Event Exposure Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29566_Neif_EventExposure.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29566_Neif_EventExposure.yaml))



# Northbound and Application Layer APIs

## CAPIF (Common API Framework)
@@ -1021,6 +1035,9 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G 
* 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))

* ADAE Data Network Energy Analytics

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29549_SS_ADAE_DN_energy_analytics.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29549_SS_ADAE_DN_energy_analytics.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))
@@ -1036,9 +1053,24 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G 
* 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))

* SAn Server Spatial Anchors Usage Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SAnUsage.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SAnUsage.yaml))

* SM Server Data Source Registration Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24550_SS_SmDataSourceRegistration.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24550_SS_SmDataSourceRegistration.yaml))

* SM Server Spatial Maps Management Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SmManagement.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SmManagement.yaml))

* SM Server Spatial Maps Discovery Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SmDiscovery.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SmDiscovery.yaml))

* SM Server Spatial Maps Localization Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SmLocalization.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SmLocalization.yaml))

* SM Server Data Source Discovery Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SmDataSourceDiscovery.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SmDataSourceDiscovery.yaml))

* SM Server SMAS registration Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29437_SS_SmSmasRegistration.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29437_SS_SmSmasRegistration.yaml))
@@ -1187,6 +1219,15 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G 
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29583_PIN_ASServiceContinuity.yaml))



## AIML App (Artificial Intelligence Machine Learning Application)

* AIMLE transfer learning (TL) enablement service (server)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimles_UeTLModelSelectionAssistance.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimles_UeTLModelSelectionAssistance.yaml))

* AIMLE transfer learning (TL) enablement service (client)

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimlec_ClientDataProcessing.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimlec_ClientDataProcessing.yaml))

* AIMLE client participation service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS24560_Aimlec_AIMLEClientParticipation.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS24560_Aimlec_AIMLEClientParticipation.yaml))

* 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))
@@ -1223,15 +1264,39 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G 
* 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))

* AIMLE Federated Learning Member Group Support Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_FLMemberGroupSupport.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_FLMemberGroupSupport.yaml))

* AIMLE Hierarchical Computing Assist Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_HierarchicalComputingAssist.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_HierarchicalComputingAssist.yaml))

* AIMLE Machine Learning Model Performance Monitor Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_MLModelPerfMonitor.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_MLModelPerfMonitor.yaml))

* AIMLE ML Model Retrieval Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_Aimles_MLModelRetrieval.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_Aimles_MLModelRetrieval.yaml))

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_MLModelRetrieval.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_MLModelRetrieval.yaml))

* AIMLE ML Model Training Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_MLModelTraining.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_MLModelTraining.yaml))

* AIMLES_ML Model Update Request Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_MLModelUpdate.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_MLModelUpdate.yaml))

* AIMLE Split Operation Event Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_SplitOpEvent.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_SplitOpEvent.yaml))

* AIMLE Split Operation Node Registration Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_Aimles_SplitOpNodeRegistration.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_Aimles_SplitOpNodeRegistration.yaml))

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_SplitOpNodeRegistration.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_SplitOpNodeRegistration.yaml))

* AIMLE Transfer Learning Model Selection Assistance Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_AIMLES_TLModelSelectionAssistance.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_AIMLES_TLModelSelectionAssistance.yaml))

* Machine Learning Federated Learning Events Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_MLR_FLEvents.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_MLR_FLEvents.yaml))

* AIMLE Repository Federated Member Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_MLR_FLMember.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_MLR_FLMember.yaml))

* MLR ML Model Management Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29482_MLR_MLModelManagement.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_MLR_MLModelManagement.yaml))
@@ -1239,6 +1304,20 @@ 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=TS29482_MLR_ModelInformationDiscovery.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29482_MLR_ModelInformationDiscovery.yaml))



## MMTel (Multimedia Telephony)

* MMTel DC Application Management Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29392_MMTel_DCAppManagement.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29392_MMTel_DCAppManagement.yaml))

* MMTel Enabler Server DC Application Call Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29392_MMTel_DCAppCall.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29392_MMTel_DCAppCall.yaml))

* MMTel Enabler Server Call Event Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29392_MMTel_CallEvent.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29392_MMTel_CallEvent.yaml))

* MMTel Enabler Server Call Control Service

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS29392_MMTel_CallControl.yaml))

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS29392_MMTel_CallControl.yaml))



# Media Delivery TS 26.510

* Common Data Types

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26510_CommonData.yaml))
@@ -1373,6 +1452,36 @@ These APIs are not part of the 5G Core Network; these APIs are exposed by the 4G 
([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26512_M5_NetworkAssistance.yaml))







# Avatar Call BAR Base Avatar Management TS 26.264



* Common Data Types  

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26264_CommonData.yaml))  

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26264_CommonData.yaml))



## BAR Management APIs



* Mbar Management Avatars  

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26264_Mbar_Management_Avatars.yaml))  

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26264_Mbar_Management_Avatars.yaml))



* Mbar Management Assets  

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26264_Mbar_Management_Assets.yaml))  

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26264_Mbar_Management_Assets.yaml))



* Mbar Management Associated Information  

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26264_Mbar_Management_AssociatedInformation.yaml))  

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26264_Mbar_Management_AssociatedInformation.yaml))



* Mbar Management Avatar Representations  

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26264_Mbar_Management_AvatarRepresentations.yaml))  

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26264_Mbar_Management_AvatarRepresentations.yaml))



* Mbar Management Sessions  

([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=TS26264_Mbar_Management_Sessions.yaml))  

([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=TS26264_Mbar_Management_Sessions.yaml))





# 3GPP SA5 models and MnS OpenAPI definitions



## Network Resource Models (NRM)

TS26264_CommonData.yaml

0 → 100755
+61 −0
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: TS26264_CommonData

  version: 1.0.0

  description: |

    Common Data Types for IMS-based AR Real-Time Communication

    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.



externalDocs:

  description: 'TS 26.264 v19.0.0; IMS-based AR Real-Time Communication'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.264/'



paths: {}



components:

  schemas:



    ###################################################

    # Annex B.1.7: Associated Information (Table B.1-9)

    ###################################################

    AssociatedInfo:

      type: object

      description: 'Associated information metadata for Base Avatars and Assets'

      properties:

        avatarId:

          $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        avatarMetadata:

          type: object

          description: 'Metadata related to the Avatar'

        assets:

          type: array

          items:

            type: object

            properties:

              assetLoDs:

                type: array

                items: 

                  type: object

                  properties:

                    level:

                      type: string

                      description: 'Level of detail identifier.'

                    size:

                      type: integer

                      description: 'The size in bytes associated with this LoD'

                description: 'A list of available LoDs for the corresponding asset with size information'

          description: 'A list of assets associated with the Base Avatar'

        selectionInfo:

          type: object

          description: 'Provides information that the user can use to select this avatar, including name, nickname, usage context, and images of renditions'

        supportedAnimations:

          type: array

          items:

            type: string

          description: 'A list of the URNs that identify the supported animation frameworks by this base avatar'

        infoUpdatedAt:

          type: number

          format: int64

          description: 'A timestamp (in wall clock time) describing the time of the last update to the associated information'

      required: [avatarId, assets, supportedAnimations, infoUpdatedAt]
 
 No newline at end of file

TS26264_Mbar_Management_Assets.yaml

0 → 100755
+273 −0

File added.

Preview size limit exceeded, changes collapsed.

TS26264_Mbar_Management_AssociatedInformation.yaml

0 → 100755
+90 −0
Original line number Diff line number Diff line 
openapi: 3.0.0

info:

  title: Mbar_Management_AssociatedInformation

  version: 1.0.0

  description: |

    Base Avatar Repository Management API - Associated Information

    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).

    All rights reserved.



tags:

  - name: AssociatedInformation

    description: 'Associated Information for Base Avatars'



externalDocs:

  description: 'TS 26.264 v19.0.0; IMS-based AR Real-Time Communication'

  url: 'https://www.3gpp.org/ftp/Specs/archive/26_series/26.264/'



servers:

  - url: '{apiRoot}/3gpp-mbar-management/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in 3GPP TS 29.501



security:

  - {}

  - OAuth2: []



paths:

  /avatars/{avatarId}/associatedInfo:

    parameters:

      - name: avatarId

        in: path

        required: true

        schema:

          $ref: 'TS26510_CommonData.yaml#/components/schemas/ResourceId'

        description: 'The unique identifier of the Avatar resource'

    get:

      tags:

        - AssociatedInformation

      operationId: getAssociatedInformation

      summary: 'Retrieve associated information corresponding to a Base Avatar'

      security:

        - OAuth2:

          - associated_info_retrieve

      responses:

        '200':

          description: 'Success'

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/AssociatedInformation'

        '400':

          $ref: 'TS29571_CommonData.yaml#/components/responses/400'

        '401':

          $ref: 'TS29571_CommonData.yaml#/components/responses/401'

        '404':

          $ref: 'TS29571_CommonData.yaml#/components/responses/404'

        '410':

          $ref: 'TS29571_CommonData.yaml#/components/responses/410'

        '413':

          $ref: 'TS29571_CommonData.yaml#/components/responses/413'

        '414':

          $ref: 'TS29571_CommonData.yaml#/components/responses/414'

        '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:

    OAuth2:

      type: oauth2

      flows:

        clientCredentials:

          tokenUrl: '{tokenUrl}'

          scopes:

            associated_info_retrieve: Retrieve Associated Information



  schemas:

    AssociatedInformation:

      type: object

      description: 'A representation of Associated Information resource'

      required:

        - associatedInfo

      properties:

        associatedInfo:

          $ref: 'TS26264_CommonData.yaml#/components/schemas/AssociatedInfo'

TS26264_Mbar_Management_AvatarRepresentations.yaml

0 → 100755
+314 −0

File added.

Preview size limit exceeded, changes collapsed.