openapi: 3.0.0
info:
  contact:
    name: VMware
  description: Interconnect capabilities APIs.
  license:
    name: Copyright (c) 2016-2017 VMware, Inc. All rights reserved.
  termsOfService: https://hcx.vmware.com/terms-and-conditions
  title: Interconnect capabilities APIs.
  version: "1.0"
servers:
- url: https://{server}/hybridity/api/interconnect
  variables:
    server:
      default: api.example.com
      description: server host name
tags:
- description: Interconnect Apis
  name: Capabilities
paths:
  /capabilities:
    get:
      description: Get interconnect capabilities
      operationId: getCapabilities
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capabilitiesListResponse'
          description: Accepted
        401:
          description: Unauthorized
        403:
          description: Forbidden
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Internal Server Error
      summary: Get interconnect capabilities
      tags:
      - Capabilities
  /capabilities/query:
    post:
      description: Query interconnect capabilities
      operationId: getCapabilitiesByFilter
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/capabilitiesFilter'
        description: Filter object.
        required: true
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/capabilitiesListResponse'
          description: Accepted
        401:
          description: Unauthorized
        403:
          description: Forbidden
        400:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Bad Request
        500:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errorResponse'
          description: Internal Server Error
      summary: Query interconnect capabilities
      tags:
      - Capabilities
components:
  schemas:
    capabilitiesFilter:
      properties:
        filter:
          $ref: '#/components/schemas/capabilitiesFilter_filter'
      type: object
    errorResponse:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/error'
          type: array
      type: object
    capabilitiesListResponse:
      example:
        warnings:
        - message: message
        - message: message
        items:
        - endpoints:
          - endpointId: endpointId
          - endpointId: endpointId
          isInterconnectCapable: true
          resourceCapabilities:
          - fleetDeploy:
              isSupported: true
              message: message
            resources:
            - resourceId: resourceId
              endpointId: endpointId
            - resourceId: resourceId
              endpointId: endpointId
            interconnectUpgrade:
              isSupported: true
              message: message
            interconnectDeploy:
              isSupported: true
              message: message
          - fleetDeploy:
              isSupported: true
              message: message
            resources:
            - resourceId: resourceId
              endpointId: endpointId
            - resourceId: resourceId
              endpointId: endpointId
            interconnectUpgrade:
              isSupported: true
              message: message
            interconnectDeploy:
              isSupported: true
              message: message
          warnings:
          - message: message
          - message: message
          isFleetCapable: true
          errors:
          - code: code
            message: message
          - code: code
            message: message
        - endpoints:
          - endpointId: endpointId
          - endpointId: endpointId
          isInterconnectCapable: true
          resourceCapabilities:
          - fleetDeploy:
              isSupported: true
              message: message
            resources:
            - resourceId: resourceId
              endpointId: endpointId
            - resourceId: resourceId
              endpointId: endpointId
            interconnectUpgrade:
              isSupported: true
              message: message
            interconnectDeploy:
              isSupported: true
              message: message
          - fleetDeploy:
              isSupported: true
              message: message
            resources:
            - resourceId: resourceId
              endpointId: endpointId
            - resourceId: resourceId
              endpointId: endpointId
            interconnectUpgrade:
              isSupported: true
              message: message
            interconnectDeploy:
              isSupported: true
              message: message
          warnings:
          - message: message
          - message: message
          isFleetCapable: true
          errors:
          - code: code
            message: message
          - code: code
            message: message
        errors:
        - code: code
          message: message
        - code: code
          message: message
      properties:
        items:
          items:
            $ref: '#/components/schemas/capability'
          type: array
        warnings:
          items:
            $ref: '#/components/schemas/warning'
          type: array
        errors:
          items:
            $ref: '#/components/schemas/error'
          type: array
      type: object
    error:
      example:
        code: code
        message: message
      properties:
        code:
          type: string
        message:
          type: string
      type: object
    capability:
      example:
        endpoints:
        - endpointId: endpointId
        - endpointId: endpointId
        isInterconnectCapable: true
        resourceCapabilities:
        - fleetDeploy:
            isSupported: true
            message: message
          resources:
          - resourceId: resourceId
            endpointId: endpointId
          - resourceId: resourceId
            endpointId: endpointId
          interconnectUpgrade:
            isSupported: true
            message: message
          interconnectDeploy:
            isSupported: true
            message: message
        - fleetDeploy:
            isSupported: true
            message: message
          resources:
          - resourceId: resourceId
            endpointId: endpointId
          - resourceId: resourceId
            endpointId: endpointId
          interconnectUpgrade:
            isSupported: true
            message: message
          interconnectDeploy:
            isSupported: true
            message: message
        warnings:
        - message: message
        - message: message
        isFleetCapable: true
        errors:
        - code: code
          message: message
        - code: code
          message: message
      properties:
        endpoints:
          items:
            $ref: '#/components/schemas/capability_endpoints'
          type: array
        isInterconnectCapable:
          type: boolean
        isFleetCapable:
          type: boolean
        resourceCapabilities:
          items:
            $ref: '#/components/schemas/capability_resourceCapabilities'
          type: array
        warnings:
          items:
            $ref: '#/components/schemas/warning'
          type: array
        errors:
          items:
            $ref: '#/components/schemas/error'
          type: array
      type: object
    warning:
      example:
        message: message
      properties:
        message:
          type: string
      type: object
    capabilitiesFilter_filter_endpoints:
      example:
        resourceId: resourceId
        endpointId: endpointId
      properties:
        endpointId:
          type: string
        resourceId:
          type: string
    capabilitiesFilter_filter:
      properties:
        endpoints:
          items:
            $ref: '#/components/schemas/capabilitiesFilter_filter_endpoints'
          type: array
    capability_endpoints:
      example:
        endpointId: endpointId
      properties:
        endpointId:
          type: string
    capability_interconnectDeploy:
      example:
        isSupported: true
        message: message
      properties:
        isSupported:
          type: boolean
        message:
          type: string
    capability_fleetDeploy:
      example:
        isSupported: true
        message: message
      properties:
        message:
          type: string
        isSupported:
          type: boolean
    capability_resourceCapabilities:
      example:
        fleetDeploy:
          isSupported: true
          message: message
        resources:
        - resourceId: resourceId
          endpointId: endpointId
        - resourceId: resourceId
          endpointId: endpointId
        interconnectUpgrade:
          isSupported: true
          message: message
        interconnectDeploy:
          isSupported: true
          message: message
      properties:
        resources:
          items:
            $ref: '#/components/schemas/capabilitiesFilter_filter_endpoints'
          type: array
        interconnectDeploy:
          $ref: '#/components/schemas/capability_interconnectDeploy'
        fleetDeploy:
          $ref: '#/components/schemas/capability_fleetDeploy'
        interconnectUpgrade:
          $ref: '#/components/schemas/capability_fleetDeploy'
  securitySchemes:
    x-hm-authorization:
      description: Obtained from /hybridity/api/session
      in: header
      name: x-hm-authorization
      type: apiKey