Commit caa20c64 authored by pastushok's avatar pastushok
Browse files

Upload New TS29482_AIMLES_AIMLEServiceOperationsManagement

parent fb90adf7
Loading
Loading
Loading
Loading
Loading
+229 −0
Original line number Diff line number Diff line
openapi: 3.0.0

info:
  title: AIMLE Service Operations Control and Management Service
  version: 1.0.0-alpha.1
  description: |
    AIMLE Service Operations Management Service.  
    © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).  
    All rights reserved.

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.482/

servers:
  - url: '{apiRoot}/aimles-ct/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: Request AIMLE service operations control and management.
      operationId: Request
      tags:
        - AIMLE Service Operation Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AimlServOperReq'
      responses:
        '200':
          description: >
            The AIMLE service operations control and management request is successfully
            received and processed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AimlServOperResp'
        '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:
    AimlServOperReq:
      description: >
        Represents the AIMLE service operations control and management request.
      type: object
      properties:
        valSvcId:
          type: string
        clients:
          type: array
          items:
            type: string
          minItems: 1
        setId:
          type: string
        operId:
          $ref: '#/components/schemas/AimleOperId'
        operInfo:
          $ref: '#/components/schemas/AimleOperInfo'
        operMode:
          $ref: '#/components/schemas/AimleOperMode'
        confModes:
          type: array
          items:
            $ref: '#/components/schemas/AimleConfigMode'
          minItems: 1
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      required:
        - operMode

    AimlServOperResp:
      description: >
        Represents the AIMLE service operations control and management response.
      type: object
      properties:
        valSvcId:
          type: string
        operId:
          $ref: '#/components/schemas/AimleOperId'
        operMode:
          $ref: '#/components/schemas/AimleOperMode'
        suppFeat:
          $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
      required:
        - operId
        - operMode

    AimleOperId:
      description: >
        Represents the AIMLE service operation identifier.
      type: object
      properties:
        trainingId:
          type: string
        taskId:
          type: string
      oneOf:
        - required: [trainingId]
        - required: [taskId]

    AimleOperInfo:
      description: >
        Represents the AIMLE service operation information.
      type: object
      properties:
        container:
          type: string
        fetchUri:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        agrUri:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri'
        assitInfo:
          $ref: '#/components/schemas/AimleOperAssist'
      required:
        - container
        - fetchUri
        - agrUri
        - assitInfo

    AimleOperAssist:
      description: >
        Represent the AIMLE service operation assistance information.
      type: object
      properties:
        maxConvTime:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'
      required:
        - maxConvTime

    AimleConfigMode:
      description: >
        Represent the AIMLE service operation configuration mode information.
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/AimleOperMode'
        measThrValues:
          $ref: '#/components/schemas/MeasurementData'
        thrDirection:
          $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MatchingDirection'
      required:
        - mode
        - measThrValues
        - thrDirection

    MeasurementData:
      description: Represent the measurement data for the AIMLE service operation.
      type: object
      properties:
        latency:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/Uinteger'
        time:
          $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime'
        accuracy:
          type: integer
          minimum: 0
          maximum: 100

# SIMPLE DATA TYPES
#

#
# ENUMERATIONS
#

    AimleOperMode:
      anyOf:
      - type: string
        enum:
          - START
          - STOP
      - type: string
        description: >
          This string provides forward-compatibility with future extensions to the enumeration
          and is not used to encode content defined in the present version of this API.
      description: |
        Represents the AIMLE service operation mode.  
        Possible values are:
        - START: Indicates the AIMLE service operation mode is start.
        - STOP: Indicates the AIMLE service operation mode is stop.