-- YAML module extracted from ITU-T M.3164.3 (10/2025)

openapi: 3.0.0
info:
  title: Interface Operations provided by SMAT
  description: This is the formal Definitions of the REST-based interface operations provided by SMAT
  termsOfService: https://www.itu.int/en/ITU-T/about/Pages/default.aspx
  contact:
    email: zhangzmx8848@gmail.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
tags:
  - name: PatrolTask-SMAT
  - name: OnsiteOverhaul-SMAT
  - name: OnsiteTroubleShooting-SMAT
  - name: ServiceActivation-SMAT

paths:
  /OnsitePatrolInfo_C={patrolInfoID}/OnsitePatrolTask_C:
    parameters: 
    - $ref: ''#/components/parameters/patrolInfoID''
    
    post:
      tags:
        - PatrolTask-SMAT 
      summary: send an on-site patrol task to the designated SMAT
      operationId: pushPatrolTasks
      requestBody:
        description: the content of patrol tasks list needs to be pushed to the designated SMAT
        content:
          application/json: 
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                patrolTasksList:
                  type: array
                  items: 
                    $ref: ''M.3164.3-Common.yaml#/components/schemas/OnsitePatrolTask_C''
        required: true
      responses:
        200:
          description: "The patrol tasks have been successfully sent to the SMAT"  
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs" 
          content: {}
  
  /OnsitePatrolInfo_C={patrolInfoID}/OnsitePatrolTask_C={taskID}/pushPatrolRoute:
    parameters: 
    - $ref: ''#/components/parameters/patrolInfoID'' 
    - $ref: ''#/components/parameters/taskID''
    
    post:
      tags:
        - PatrolTask-SMAT 
      summary: push the on-site patrol route to the designated SMAT
      operationId: pushPatrolRoute
      requestBody:
        description: the content of the patrol route needs to be pushed to the designated SMAT
        content:
          application/json: 
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                patrolRoute:
                  type: array
                  items:
                    $ref: ''M.3164.3-Common.yaml#/components/schemas/OnsitePatrolPoint_C''
        required: true
      responses:
        200:
          description: "The patrol route has been successfully sent to the SMAT"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description:  "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs" 
          content: {}
                
  /OnsitePatrolInfo_C={patrolInfoID}/OnsitePatrolTask_C={taskID}/pushSmartIDData:
    parameters: 
    - $ref: ''#/components/parameters/patrolInfoID'' 
    - $ref: ''#/components/parameters/taskID''
    
    post:
      tags:
        - PatrolTask-SMAT 
      summary: push the smart identification data of the patrol object to the designated SMAT
      operationId: pushSmartIDData        
      requestBody:
        description: the smart identification data of the patrol object needs to be pushed to the designated SMAT
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                smartIDData:
                  type: array
                  items:
                    $ref: ''#/components/schemas/ObjectImageListType''
        required: true       
      responses:
        200:
          description: "The smart identification data has been successfully sent to the SMAT" 
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs" 
          content: {} 

  /OnsiteOverhaulInfo_C={overhaulInfoID}/OnsiteOverhaulTask_C:
    parameters: 
    - $ref: ''#/components/parameters/overhaulInfoID'' 

    post:
      tags:
        - OnsiteOverhaul-SMAT 
      summary: push an on-site overhaul maintenance job to the designated SMAT
      operationId: pushMaintenanceJob
      requestBody:       
        description: the content of overhaul maintenance job needs to be pushed to the designated SMAT
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                overhaulTaskList:
                  type: array
                  items:
                    $ref: ''M.3164.3-Common.yaml#/components/schemas/OnsiteOverhaulTask_C''
        required: true
      responses:
        200:
          description: "The overhaul maintenance job has been successfully sent to the SMAT"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs"
          content: {} 

  /OnsiteOverhaulInfo_C={overhaulInfoID}/OnsiteOverhaulTask_C={taskID}/pushOverhaulGuidanceInfo:
    parameters: 
    - $ref: ''#/components/parameters/overhaulInfoID'' 
    - $ref: ''#/components/parameters/taskID''
    
    post:
      tags:
        - OnsiteOverhaul-SMAT
      summary: push the on-site overhaul guidance information to the designated SMAT
      operationId: pushOverhaulGuidanceInfo    
      requestBody:
        description: guidance information for on-site overhaul tasks needs to be pushed to the designated the SMAT
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                guidanceInfo:
                  type: string
        required: true       
      responses:
        200:
          description: "The on-site overhaul guidance information has been successfully sent to the SMAT"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs"
          content: {} 

  /OnsiteTroubleShootingInfo_C={troubleShootingInfoID}/OnsiteTroubleShootingTask_C:
    parameters: 
    - $ref: ''#/components/parameters/troubleShootingInfoID'' 
    
    post:
      tags:
        - OnsiteTroubleShooting-SMAT 
      summary: push the information of on-site troubleshooting tasks to the designated SMAT
      operationId: pushTroubleShootingTasks
      requestBody:
        description: the content of on-site troubleshooting tasks needs to be pushed to the designated SMAT
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                troubleShootingTaskList:
                  type: array
                  items:
                    $ref: ''M.3164.3-Common.yaml#/components/schemas/OnsiteTroubleShootingTask_C''
        required: true
      responses:
        200:
          description: "The on-site troubleshooting tasks have been successfully sent to the SMAT"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs" 
          content: {}     
          
  /OnsiteTroubleShootingInfo_C={troubleShootingInfoID}/OnsiteTroubleShootingTask_C={taskID}/pushTroubleShootingGuidance:
    parameters: 
    - $ref: ''#/components/parameters/troubleShootingInfoID'' 
    - $ref: ''#/components/parameters/taskID'' 
    
    post:
      tags:
        - OnsiteTroubleShooting-SMAT
      summary: push the troubleShooting guidance information to the SMAT
      operationId: pushTroubleShootingGuidance
      requestBody:
        description: guidance information for on-site troubleShooting tasks needs to be pushed to the designated SMAT
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                operationGuidanceInfo:
                  type: string
        required: true       
      responses:
        200:
          description: "The on-site troubleShooting guidance information has been successfully sent to the SMAT"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs" 
          content: {}  
    
  /OnsiteTroubleShootingInfo_C={troubleShootingInfoID}/OnsiteTroubleShootingTask_C={taskID}/pushTroubleAnalysisResult:
    parameters: 
    - $ref: ''#/components/parameters/troubleShootingInfoID''
    - $ref: ''#/components/parameters/taskID''
    
    post:
      tags:
        - OnsiteTroubleShooting-SMAT 
      summary: push the trouble analysis result to the SMAT
      operationId: pushTroubleAnalysisResult      
      requestBody:
        description: the content of on-site trouble analysis result needs to be pushed to the designated SMAT
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                troubleTypeID:
                  type: string
                  format: uri
                causeList:
                  type: array
                  items:
                    $ref: ''#/components/schemas/CauseListType''  
                imagesList:
                  type: array
                  items:
                    $ref: ''#/components/schemas/ImagesListType''      
        required: true       
      responses:
        200:
          description: "The trouble analysis result has been successfully sent to the SMAT"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs" 
          content: {}  

  /ServiceActivationInfo_C={serviceActInfoID}/ServiceActivationTask_C:
    parameters: 
    - $ref: ''#/components/parameters/serviceActInfoID'' 
    
    post:
      tags:
        - ServiceActivation-SMAT 
      summary: push the information of the service activation job to the SMAT
      operationId: pushServiceActJob
      requestBody:
        description: the content of service activation jobs list needs to be pushed to the designated SMAT.
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                serviceActTaskList:
                  type: array
                  items:
                    $ref: ''M.3164.3-Common.yaml#/components/schemas/ServiceActivationTask_C''
        required: true
      responses:
        200:
          description: "The service activation job has been successfully sent to the SMAT"  
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        500:
          description: "An internal problem occurs" 
          content: {}
          
components:
  schemas:   
    OpStatusType:
      type: object
      properties:
        opStatus:
          type: string
          enum:
            - successful
            - failed
        
    ObjectImageListType:
      type: array
      items:
        $ref: ''#/components/schemas/ObjectImageType''
      
    ObjectImageType:
      type: object
      properties:
        objectID:
          type: string
        image:
          type: string 
          format: byte

    CauseListType:
      type: array
      items:
        type: string
        
    ImagesListType:
      type: array
      items:
        type: string
        format: byte 


  parameters: 
    patrolInfoID:
      name: patrolInfoID
      in: path
      required: true
      description: ID of the on-site patrol task information
      schema:
        type: string

    taskID:
      name: taskID
      in: path
      description: ID of an on-site patrol task, or an on-site overhaul task, or an on-site troubleshooting task, or a service activation task
      required: true
      schema:
        type: string

    overhaulInfoID:
      name: overhaulInfoID
      in: path
      description: ID of the on-site overhaul maintenance job information
      required: true
      schema:
        type: string
        
    troubleShootingInfoID:
      name: troubleShootingInfoID
      in: path
      description: ID of the on-site troubleshooting task information
      required: true
      schema:
       type: string  
      
    serviceActInfoID:
      name: serviceActInfoID
      in: path
      description: ID of the service activation job information
      required: true
      schema:
        type: string