Upload New File TS29482_Aimles_SplitOpNodeRegistration

openapi: 3.0.0

info:

  title: Aimles_SplitOpNodeRegistration

  description: |

    API for AIMLE Split Operation Node Register Configurations.  

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

    All rights reserved.

  version: "1.0.0-alpha.1"

externalDocs:

  description: >

    3GPP TS 29.482 v1.1.0; Artificial Intelligence Machine Learning Enablement 

    (AIMLE) Services; Stage 3.

  url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/

servers:

  - url: '{apiRoot}/aimles-sonreg/v1'

    variables:

      apiRoot:

        default: https://example.com

        description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122

security:

  - {}

  - oAuth2ClientCredentials: []

paths:

  /configurations:

    post:

      summary: Request the creation of a Individual AIMLE Split Operation Node Register.

      operationId: CreateAimleSplitOpNodeRegSubscription

      tags:

        - AIMLE Split Operation Node Register Configurations (Collection)

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '201':

          description: >

            The registration of the new Individual AIMLE AIMLE Split Operation Node Register is confirmed

            and a representation of that resource is returned.

          content:

            application/json:

              schema:

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

          headers:

            Location:

              description: Contains the URI of the newly created resource.

              required: true

              schema:

                type: string

        '400':

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

        '401':

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

        '403':

          $ref: 'TS29122_CommonData.yaml#/components/responses/403'

        '404':

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

        '411':

          $ref: 'TS29122_CommonData.yaml#/components/responses/411'

        '413':

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

        '415':

          $ref: 'TS29122_CommonData.yaml#/components/responses/415'

        '429':

          $ref: 'TS29122_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29122_CommonData.yaml#/components/responses/500'

        '503':

          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

  /configurations/{configurationId}:

    get:

      summary: Retrieve an existing Individual AIMLE Split Operation Node Register resource.

      operationId: GetIndAimleSplitOpNodeRegSubscription

      tags:

        - Individual AIMLE Split Operation Node Register Configuration (Document)

      parameters:

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      responses:

        '200':

          description: >

            OK. The requested information on the Individual Resgietered AIMLE Split

            Operation Node Register is confirmed and a representation of that resource is returned.

          content:

            application/json:

              schema:

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

        '307':

          $ref: 'TS29122_CommonData.yaml#/components/responses/307'

        '308':

          $ref: 'TS29122_CommonData.yaml#/components/responses/308'

        '400':

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

        '401':

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

        '403':

          $ref: 'TS29122_CommonData.yaml#/components/responses/403'

        '404':

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

        '406':

          $ref: 'TS29122_CommonData.yaml#/components/responses/406'

        '429':

          $ref: 'TS29122_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29122_CommonData.yaml#/components/responses/500'

        '503':

          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

    put:

      summary: Request the update of an existing Individual AIMLE Split Operation Node Register resource.

      operationId: UpdateIndAimleSplitOpNodeRegSubscription

      tags:

        - Individual AIMLE Split Operation Node Register Configuration (Document)

      parameters:

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      requestBody:

        required: true

        content:

          application/json:

            schema:

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

      responses:

        '200':

          description: >

            OK. The requested update of the Individual Registered AIMLE Split Operation

            Node Register is confirmed and a representation of that resource is returned.

          content:

            application/json:

              schema:

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

        '204':

          description: >

            No Content. The Individual AIMLE Split Operation Node Register resource is

            successfully updated and no content is returned in the response body.

        '307':

          $ref: 'TS29122_CommonData.yaml#/components/responses/307'

        '308':

          $ref: 'TS29122_CommonData.yaml#/components/responses/308'

        '400':

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

        '401':

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

        '403':

          $ref: 'TS29122_CommonData.yaml#/components/responses/403'

        '404':

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

        '411':

          $ref: 'TS29122_CommonData.yaml#/components/responses/411'

        '413':

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

        '415':

          $ref: 'TS29122_CommonData.yaml#/components/responses/415'

        '429':

          $ref: 'TS29122_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29122_CommonData.yaml#/components/responses/500'

        '503':

          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

    patch:

      summary: Request the modification of an existing Individual AIMLE Split Operation Node Register resource.

      operationId: ModifyIndAimleSplitOpNodeRegSubscription

      tags:

        - Individual AIMLE Split Operation Node Register Configuration (Document)

      parameters:

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      requestBody:

        required: true

        content:

          application/merge-patch+json:

            schema:

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

      responses:

        '200':

          description: >

            OK. The requested modification of the Individual Registered AIMLE Split Operation Node

            Register is confirmed and a representation of that resource is returned.

          content:

            application/json:

              schema:

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

        '204':

          description: >

            No Content. The requested modification of the Individual Registered AIMLE Split

            Operation Node Register is confirmed and no content is returned.

        '307':

          $ref: 'TS29122_CommonData.yaml#/components/responses/307'

        '308':

          $ref: 'TS29122_CommonData.yaml#/components/responses/308'

        '400':

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

        '401':

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

        '403':

          $ref: 'TS29122_CommonData.yaml#/components/responses/403'

        '404':

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

        '411':

          $ref: 'TS29122_CommonData.yaml#/components/responses/411'

        '413':

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

        '415':

          $ref: 'TS29122_CommonData.yaml#/components/responses/415'

        '429':

          $ref: 'TS29122_CommonData.yaml#/components/responses/429'

        '500':

          $ref: 'TS29122_CommonData.yaml#/components/responses/500'

        '503':

          $ref: 'TS29122_CommonData.yaml#/components/responses/503'

        default:

          $ref: 'TS29122_CommonData.yaml#/components/responses/default'

    delete:

      summary: Remove the Individual AIMLE Split Operation Node Register.

      operationId: UnsubscribeAimleSplitOpNodeRegSubscription

      tags:

        - Individual AIMLE Split Operation Node Register Configuration (Document).

      parameters:

        - name: configurationId

          in: path

          description: Identifier of the configuration resource

          required: true

          schema:

            type: string

      responses:

        '204':

          description: >

            Deregistration of the Individual Registered AIMLE Split Operation Node Register is

            confirmed.

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

    SplitOpNodeReg:

      description: Represents the Split Operation Node Register information.

      type: object

      properties:

        nodeInfo:

          $ref: 'TS29548_SDD_Transmission.yaml#/components/schemas/ConnInfo'

        sonRegCapability:

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

        timeValidity:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'

      required:

        - nodeInfo

    SplitOpNodeRegPatch:

      description: Represents the split operation node register information to be modified.

      type: object

      properties:

        sonregCapability:

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

        timeValidity:

          $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow'

    SplitOpCapabilities:

      description: Represents the split operation capabilities.

      type: object

      properties:

        modelInfo:

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

        usageInfo:

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

      required:

        - modelInfo

    ModelInformation:

      description: Represents the ML model information.

      type: object

      properties:

        modelId:

          type: string

        modelName:

          type: string

        modelVersion:

          type: string

        suppOperation:

          type: array

          items:

            type: string

          minItems: 1

      required:

        - modelId

        - modelVersion

        - suppOperation

    UsageInformation:

      description: Represents the data analysis requirement.

      type: object

      properties:

        inputFreq:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

        inputSize:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

        outputFreq:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

        outputSize:

          $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger'

# SIMPLE DATA TYPES

#

#

# ENUMERATIONS

#