openapi: 3.0.1
info:
  title: Application Orchestrator REST API
  description: Application Orchestrator REST API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
servers:
- url: //127.0.0.1:30201/
tags:
- name: app-orchestrator-handler
  description: App Orchestrator Handler
- name: app-rule-handler
  description: App Rule Handler
- name: appo-db-handler
  description: Appo Db Handler
paths:
  /appo/v1/health:
    get:
      tags:
      - app-orchestrator-handler
      summary: Queries liveness and readiness
      operationId: healthCheckUsingGET
      responses:
        200:
          description: OK
          content:
            text/plain:
              schema:
                type: string
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
  /appo/v1/tenants/{tenant_id}/app_instance_infos:
    get:
      tags:
      - appo-db-handler
      summary: Retrieves application instance info
      operationId: getAllAppInstanceInfoUsingGET
      parameters:
      - name: appinstanceids
        in: query
        description: appinstanceids
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
  /appo/v1/tenants/{tenant_id}/app_instance_infos/{appInstance_id}:
    get:
      tags:
      - appo-db-handler
      summary: Retrieves application instance info
      operationId: getAppInstanceInfoUsingGET
      parameters:
      - name: appInstance_id
        in: path
        description: application instance id
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
  /appo/v1/tenants/{tenant_id}/app_instances:
    post:
      tags:
      - app-orchestrator-handler
      summary: Creates application instance
      operationId: createAppInstanceUsingPOST
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      requestBody:
        description: create application instance
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateParam'
        required: false
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        201:
          description: 'request accepted '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
        500:
          description: internal server error
          content:
            application/json:
              schema:
                type: string
      deprecated: false
      x-codegen-request-body-name: createParam
  /appo/v1/tenants/{tenant_id}/app_instances/batch_create:
    post:
      tags:
      - app-orchestrator-handler
      summary: Batch creates application instances
      operationId: batchCreateAppInstanceUsingPOST
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      requestBody:
        description: create application instance
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCreateParam'
        required: false
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        201:
          description: 'request accepted '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
        500:
          description: internal server error
          content:
            application/json:
              schema:
                type: string
      deprecated: false
      x-codegen-request-body-name: createParam
  /appo/v1/tenants/{tenant_id}/app_instances/batch_instantiate:
    post:
      tags:
      - app-orchestrator-handler
      summary: Batch instantiate application instances
      operationId: batchInstantiateAppInstanceUsingPOST
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      requestBody:
        description: Instantiate application instances
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchInstancesParam'
        required: false
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        201:
          description: 'request accepted '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
        500:
          description: internal server error
          content:
            application/json:
              schema:
                type: string
      deprecated: false
      x-codegen-request-body-name: appInstanceParam
  /appo/v1/tenants/{tenant_id}/app_instances/batch_terminate:
    post:
      tags:
      - app-orchestrator-handler
      summary: Batch terminate application instances
      operationId: batchTerminateAppInstancesUsingPOST
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      requestBody:
        description: Batch terminate application instances
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchInstancesParam'
        required: false
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        201:
          description: 'request accepted '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
        500:
          description: internal server error
          content:
            application/json:
              schema:
                type: string
      deprecated: false
      x-codegen-request-body-name: appInstanceParam
  /appo/v1/tenants/{tenant_id}/app_instances/{app_instance_id}:
    get:
      tags:
      - app-orchestrator-handler
      summary: Retrieves application instance information
      operationId: getAppInstanceUsingGET
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: app_instance_id
        in: path
        description: application instance id
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
    post:
      tags:
      - app-orchestrator-handler
      summary: Instantiate application instance
      operationId: instantiateAppInstanceUsingPOST
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: app_instance_id
        in: path
        description: application instance id
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        201:
          description: 'request accepted '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
        500:
          description: internal server error
          content:
            application/json:
              schema:
                type: string
      deprecated: false
    delete:
      tags:
      - app-orchestrator-handler
      summary: Terminates application instance
      operationId: terminateAppInstanceUsingDELETE
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: app_instance_id
        in: path
        description: application instance id
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        201:
          description: 'request accepted '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        204:
          description: No Content
          content: {}
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        500:
          description: internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
      deprecated: false
  /appo/v1/tenants/{tenant_id}/app_instances/{app_instance_id}/appd_configuration:
    put:
      tags:
      - app-rule-handler
      summary: Updates application rules
      operationId: updateApplicationRulesUsingPUT
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: app_instance_id
        in: path
        description: app instance identifier
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant identifier
        required: true
        schema:
          type: string
      requestBody:
        description: appD rule inventory information
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppRuleConfigDto'
        required: false
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: string
        201:
          description: Created
          content: {}
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
      x-codegen-request-body-name: appRuleConfigDto
    post:
      tags:
      - app-rule-handler
      summary: Configure application rules
      operationId: addAppRulesUsingPOST
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: app_instance_id
        in: path
        description: app instance identifier
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant identifier
        required: true
        schema:
          type: string
      requestBody:
        description: appD rule inventory information
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppRuleConfigDto'
        required: false
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: string
        201:
          description: Created
          content: {}
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
      x-codegen-request-body-name: appRuleConfigDto
    delete:
      tags:
      - app-rule-handler
      summary: Deletes application rules
      operationId: deleteApplicationRulesUsingDELETE
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: app_instance_id
        in: path
        description: app instance identifier
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant identifier
        required: true
        schema:
          type: string
      requestBody:
        description: app rule information
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AppRuleDeleteConfigDto'
        required: false
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: string
        204:
          description: No Content
          content: {}
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
      deprecated: false
      x-codegen-request-body-name: appRuleDelConfigDto
  /appo/v1/tenants/{tenant_id}/apprule_task_infos/{apprule_task_id}:
    get:
      tags:
      - appo-db-handler
      summary: Retrieves application rule task info
      operationId: getAppRuletaskInfoUsingGET
      parameters:
      - name: apprule_task_id
        in: path
        description: application instance id
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
  /appo/v1/tenants/{tenant_id}/hosts/{host_ip}/kpi:
    get:
      tags:
      - app-orchestrator-handler
      summary: Retrieves edge host performance statistics
      operationId: queryKpiUsingGET
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: host_ip
        in: path
        description: edge host ip
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant_id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
  /appo/v1/tenants/{tenant_id}/hosts/{host_ip}/mep_capabilities:
    get:
      tags:
      - app-orchestrator-handler
      summary: Retrieves edge host platform capabilities
      operationId: queryEdgehostCapabilitiesUsingGET
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: host_ip
        in: path
        description: edge host ip
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
  /appo/v1/tenants/{tenant_id}/hosts/{host_ip}/mep_capabilities/{capability_id}:
    get:
      tags:
      - app-orchestrator-handler
      summary: Retrieves edge host platform capabilities
      operationId: queryEdgehostCapabilityUsingGET
      parameters:
      - name: access_token
        in: header
        description: access token
        schema:
          type: string
      - name: capability_id
        in: path
        description: capability_id
        required: true
        schema:
          type: string
      - name: host_ip
        in: path
        description: edge host ip
        required: true
        schema:
          type: string
      - name: tenant_id
        in: path
        description: tenant id
        required: true
        schema:
          type: string
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppoResponse'
        401:
          description: Unauthorized
          content: {}
        403:
          description: Forbidden
          content: {}
        404:
          description: Not Found
          content: {}
      deprecated: false
components:
  schemas:
    AppRuleConfigDto:
      title: AppRuleConfigDto
      type: object
      properties:
        appDNSRule:
          type: array
          items:
            $ref: '#/components/schemas/DnsRuleDto'
        appName:
          type: string
        appSupportMp1:
          type: boolean
        appTrafficRule:
          type: array
          items:
            $ref: '#/components/schemas/TrafficRuleDto'
    AppRuleDeleteConfigDto:
      title: AppRuleDeleteConfigDto
      type: object
      properties:
        appDNSRule:
          type: array
          items:
            type: string
        appTrafficRule:
          type: array
          items:
            type: string
    AppoResponse:
      title: AppoResponse
      type: object
      properties:
        response:
          type: object
          properties: {}
    BatchCreateParam:
      title: BatchCreateParam
      type: object
      properties:
        appId:
          type: string
        appInstanceDescription:
          type: string
        appName:
          type: string
        appPackageId:
          type: string
        hwCapabilities:
          type: array
          items:
            type: string
        mecHost:
          type: array
          items:
            type: string
    BatchInstancesParam:
      title: BatchInstancesParam
      type: object
      properties:
        appInstanceIds:
          type: array
          items:
            type: string
    CreateParam:
      title: CreateParam
      type: object
      properties:
        appId:
          type: string
        appInstanceDescription:
          type: string
        appName:
          type: string
        appPackageId:
          type: string
        hwCapabilities:
          type: array
          items:
            type: string
        mecHost:
          type: string
    DnsRuleDto:
      title: DnsRuleDto
      type: object
      properties:
        dnsRuleId:
          type: string
        domainName:
          type: string
        ipAddress:
          type: string
        ipAddressType:
          type: string
          enum:
          - IP_V4
          - IP_V6
        ttl:
          type: integer
          format: int32
    DstInterfaceDto:
      title: DstInterfaceDto
      type: object
      properties:
        dstIpAddress:
          type: string
        dstMacAddress:
          type: string
        interfaceType:
          type: string
        srcMacAddress:
          type: string
        tunnelInfo:
          $ref: '#/components/schemas/TunnelInfoDto'
    TrafficFilterDto:
      title: TrafficFilterDto
      type: object
      properties:
        dscp:
          type: integer
          format: int32
        dstAddress:
          type: array
          items:
            type: string
        dstPort:
          type: array
          items:
            type: string
        dstTunnelAddress:
          type: array
          items:
            type: string
        dstTunnelPort:
          type: array
          items:
            type: string
        protocol:
          type: array
          items:
            type: string
        qci:
          type: integer
          format: int32
        srcAddress:
          type: array
          items:
            type: string
        srcPort:
          type: array
          items:
            type: string
        srcTunnelAddress:
          type: array
          items:
            type: string
        srcTunnelPort:
          type: array
          items:
            type: string
        tag:
          type: array
          items:
            type: string
        tc:
          type: integer
          format: int32
    TrafficRuleDto:
      title: TrafficRuleDto
      type: object
      properties:
        action:
          type: string
          enum:
          - DROP
          - FORWARD_DECAPSULATED
          - FORWARD_AS_IS
          - PASSTHROUGH
          - DUPLICATED_DECAPSULATED
          - DUPLICATE_AS_IS
        dstInterface:
          type: array
          items:
            $ref: '#/components/schemas/DstInterfaceDto'
        filterType:
          type: string
          enum:
          - FLOW
          - PACKET
        priority:
          type: integer
          format: int32
        trafficFilter:
          type: array
          items:
            $ref: '#/components/schemas/TrafficFilterDto'
        trafficRuleId:
          type: string
    TunnelInfoDto:
      title: TunnelInfoDto
      type: object
      properties:
        tunnelDstAddress:
          type: string
        tunnelSpecificData:
          type: string
        tunnelSrcAddress:
          type: string
        tunnelType:
          type: string