basePath: /tumblebug
definitions:
  common.ConfigInfo:
    properties:
      id:
        example: SPIDER_REST_URL
        type: string
      name:
        example: SPIDER_REST_URL
        type: string
      value:
        example: http://localhost:1024/spider
        type: string
    type: object
  common.ConfigReq:
    properties:
      name:
        example: SPIDER_REST_URL
        type: string
      value:
        example: http://localhost:1024/spider
        type: string
    type: object
  common.ConnConfig:
    properties:
      configName:
        type: string
      credentialName:
        type: string
      driverName:
        type: string
      location:
        $ref: '#/definitions/common.GeoLocation'
      providerName:
        type: string
      regionName:
        type: string
    type: object
  common.ConnConfigList:
    properties:
      connectionconfig:
        items:
          $ref: '#/definitions/common.ConnConfig'
        type: array
    type: object
  common.GeoLocation:
    properties:
      briefAddr:
        type: string
      cloudType:
        type: string
      latitude:
        type: string
      longitude:
        type: string
      nativeRegion:
        type: string
    type: object
  common.IID:
    properties:
      nameId:
        description: NameID by user
        type: string
      systemId:
        description: SystemID by CloudOS
        type: string
    type: object
  common.IdList:
    properties:
      output:
        items:
          type: string
        type: array
    type: object
  common.JSONResult:
    type: object
  common.KeyValue:
    properties:
      key:
        type: string
      value:
        type: string
    type: object
  common.NsInfo:
    properties:
      description:
        example: Description for this namespace
        type: string
      id:
        example: ns01
        type: string
      name:
        example: ns01
        type: string
    type: object
  common.NsReq:
    properties:
      description:
        example: Description for this namespace
        type: string
      name:
        example: ns01
        type: string
    type: object
  common.Region:
    properties:
      keyValueInfoList:
        description: ex) { {region, us-east1}, {zone, us-east1-c} }
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      providerName:
        description: ex) "GCP"
        type: string
      regionName:
        description: ex) "region01"
        type: string
    type: object
  common.RegionList:
    properties:
      region:
        items:
          $ref: '#/definitions/common.Region'
        type: array
    type: object
  common.RestGetAllConfigResponse:
    properties:
      config:
        description: Name string     `json:"name"`
        items:
          $ref: '#/definitions/common.ConfigInfo'
        type: array
    type: object
  common.RestGetAllNsResponse:
    properties:
      ns:
        description: Name string     `json:"name"`
        items:
          $ref: '#/definitions/common.NsInfo'
        type: array
    type: object
  common.RestInspectResourcesRequest:
    properties:
      connectionName:
        example: aws-ap-southeast-1
        type: string
      resourceType:
        enum:
        - vNet
        - securityGroup
        - sshKey
        - vm
        example: vNet
        type: string
    type: object
  common.RestRegisterCspNativeResourcesRequest:
    properties:
      connectionName:
        example: aws-ap-southeast-1
        type: string
      mcisName:
        example: csp
        type: string
      nsId:
        example: ns01
        type: string
    type: object
  common.RestRegisterCspNativeResourcesRequestAll:
    properties:
      mcisName:
        example: csp
        type: string
      nsId:
        example: ns01
        type: string
    type: object
  common.SimpleMsg:
    properties:
      message:
        example: Any message
        type: string
    type: object
  common.TbConnectionName:
    properties:
      connectionName:
        type: string
    type: object
  mcir.FilterSpecsByRangeRequest:
    properties:
      connectionName:
        type: string
      costPerHour:
        $ref: '#/definitions/mcir.Range'
      cspSpecName:
        type: string
      description:
        type: string
      ebsBwMbps:
        $ref: '#/definitions/mcir.Range'
      evaluationScore01:
        $ref: '#/definitions/mcir.Range'
      evaluationScore02:
        $ref: '#/definitions/mcir.Range'
      evaluationScore03:
        $ref: '#/definitions/mcir.Range'
      evaluationScore04:
        $ref: '#/definitions/mcir.Range'
      evaluationScore05:
        $ref: '#/definitions/mcir.Range'
      evaluationScore06:
        $ref: '#/definitions/mcir.Range'
      evaluationScore07:
        $ref: '#/definitions/mcir.Range'
      evaluationScore08:
        $ref: '#/definitions/mcir.Range'
      evaluationScore09:
        $ref: '#/definitions/mcir.Range'
      evaluationScore10:
        $ref: '#/definitions/mcir.Range'
      evaluationStatus:
        type: string
      gpuMemGiB:
        $ref: '#/definitions/mcir.Range'
      gpuModel:
        type: string
      gpuP2p:
        type: string
      id:
        type: string
      maxNumStorage:
        $ref: '#/definitions/mcir.Range'
      maxTotalStorageTiB:
        $ref: '#/definitions/mcir.Range'
      memGiB:
        $ref: '#/definitions/mcir.Range'
      name:
        type: string
      netBwGbps:
        $ref: '#/definitions/mcir.Range'
      numGpu:
        $ref: '#/definitions/mcir.Range'
      numStorage:
        $ref: '#/definitions/mcir.Range'
      numcore:
        $ref: '#/definitions/mcir.Range'
      numvCPU:
        $ref: '#/definitions/mcir.Range'
      osType:
        type: string
      providerName:
        type: string
      regionName:
        type: string
      storageGiB:
        $ref: '#/definitions/mcir.Range'
    type: object
  mcir.JSONResult:
    type: object
  mcir.Range:
    properties:
      max:
        type: number
      min:
        type: number
    type: object
  mcir.RestFilterSpecsResponse:
    properties:
      spec:
        items:
          $ref: '#/definitions/mcir.TbSpecInfo'
        type: array
    type: object
  mcir.RestGetAllImageResponse:
    properties:
      image:
        items:
          $ref: '#/definitions/mcir.TbImageInfo'
        type: array
    type: object
  mcir.RestGetAllSecurityGroupResponse:
    properties:
      securityGroup:
        items:
          $ref: '#/definitions/mcir.TbSecurityGroupInfo'
        type: array
    type: object
  mcir.RestGetAllSpecResponse:
    properties:
      spec:
        items:
          $ref: '#/definitions/mcir.TbSpecInfo'
        type: array
    type: object
  mcir.RestGetAllSshKeyResponse:
    properties:
      sshKey:
        items:
          $ref: '#/definitions/mcir.TbSshKeyInfo'
        type: array
    type: object
  mcir.RestGetAllVNetResponse:
    properties:
      vNet:
        items:
          $ref: '#/definitions/mcir.TbVNetInfo'
        type: array
    type: object
  mcir.RestLookupImageRequest:
    properties:
      connectionName:
        type: string
      cspImageId:
        type: string
    type: object
  mcir.RestLookupSpecRequest:
    properties:
      connectionName:
        type: string
      cspSpecName:
        type: string
    type: object
  mcir.RestSearchImageRequest:
    properties:
      keywords:
        items:
          type: string
        type: array
    type: object
  mcir.SpiderGpuInfo:
    properties:
      count:
        type: string
      mem:
        type: string
      mfr:
        type: string
      model:
        type: string
    type: object
  mcir.SpiderImageInfo:
    properties:
      guestOS:
        description: Windows7, Ubuntu etc.
        type: string
      iid:
        $ref: '#/definitions/common.IID'
        description: Fields for response
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        description: Fields for request
        type: string
      status:
        description: available, unavailable
        type: string
    type: object
  mcir.SpiderImageList:
    properties:
      image:
        items:
          $ref: '#/definitions/mcir.SpiderImageInfo'
        type: array
    type: object
  mcir.SpiderSpecInfo:
    properties:
      gpu:
        items:
          $ref: '#/definitions/mcir.SpiderGpuInfo'
        type: array
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      mem:
        type: string
      name:
        type: string
      region:
        type: string
      vcpu:
        $ref: '#/definitions/mcir.SpiderVCpuInfo'
    type: object
  mcir.SpiderSpecList:
    properties:
      vmspec:
        items:
          $ref: '#/definitions/mcir.SpiderSpecInfo'
        type: array
    type: object
  mcir.SpiderVCpuInfo:
    properties:
      clock:
        description: GHz
        type: string
      count:
        type: string
    type: object
  mcir.TbFirewallRuleInfo:
    properties:
      cidr:
        type: string
      direction:
        description: '`json:"direction"`'
        type: string
      fromPort:
        description: '`json:"fromPort"`'
        type: string
      ipprotocol:
        description: '`json:"ipProtocol"`'
        type: string
      toPort:
        description: '`json:"toPort"`'
        type: string
    required:
    - direction
    - fromPort
    - ipprotocol
    - toPort
    type: object
  mcir.TbFirewallRulesWrapper:
    properties:
      firewallRules:
        description: validate:"required"`
        items:
          $ref: '#/definitions/mcir.TbFirewallRuleInfo'
        type: array
    type: object
  mcir.TbImageInfo:
    properties:
      associatedObjectList:
        items:
          type: string
        type: array
      connectionName:
        type: string
      creationDate:
        type: string
      cspImageId:
        type: string
      cspImageName:
        type: string
      description:
        type: string
      guestOS:
        description: Windows7, Ubuntu etc.
        type: string
      id:
        type: string
      isAutoGenerated:
        type: boolean
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        type: string
      namespace:
        description: required to save in RDB
        type: string
      status:
        description: available, unavailable
        type: string
      systemLabel:
        description: SystemLabel is for describing the MCIR in a keyword (any string
          can be used) for special System purpose
        example: Managed by CB-Tumblebug
        type: string
    type: object
  mcir.TbImageReq:
    properties:
      connectionName:
        type: string
      cspImageId:
        type: string
      description:
        type: string
      name:
        type: string
    required:
    - connectionName
    - cspImageId
    - name
    type: object
  mcir.TbSecurityGroupInfo:
    properties:
      associatedObjectList:
        items:
          type: string
        type: array
      connectionName:
        type: string
      cspSecurityGroupId:
        type: string
      cspSecurityGroupName:
        type: string
      description:
        type: string
      firewallRules:
        items:
          $ref: '#/definitions/mcir.TbFirewallRuleInfo'
        type: array
      id:
        type: string
      isAutoGenerated:
        type: boolean
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        type: string
      systemLabel:
        description: SystemLabel is for describing the MCIR in a keyword (any string
          can be used) for special System purpose
        example: Managed by CB-Tumblebug
        type: string
      vNetId:
        type: string
    type: object
  mcir.TbSecurityGroupReq:
    properties:
      connectionName:
        type: string
      cspSecurityGroupId:
        description: CspSecurityGroupId is required to register object from CSP (option=register)
        type: string
      description:
        type: string
      firewallRules:
        description: validate:"required"`
        items:
          $ref: '#/definitions/mcir.TbFirewallRuleInfo'
        type: array
      name:
        type: string
      vNetId:
        type: string
    required:
    - connectionName
    - name
    - vNetId
    type: object
  mcir.TbSpecInfo:
    properties:
      associatedObjectList:
        items:
          type: string
        type: array
      connectionName:
        type: string
      costPerHour:
        type: number
      cspSpecName:
        type: string
      description:
        type: string
      ebsBwMbps:
        type: integer
      evaluationScore01:
        type: number
      evaluationScore02:
        type: number
      evaluationScore03:
        type: number
      evaluationScore04:
        type: number
      evaluationScore05:
        type: number
      evaluationScore06:
        type: number
      evaluationScore07:
        type: number
      evaluationScore08:
        type: number
      evaluationScore09:
        type: number
      evaluationScore10:
        type: number
      evaluationStatus:
        type: string
      gpuMemGiB:
        type: number
      gpuModel:
        type: string
      gpuP2p:
        type: string
      id:
        type: string
      isAutoGenerated:
        type: boolean
      maxNumStorage:
        type: integer
      maxTotalStorageTiB:
        type: integer
      memGiB:
        type: number
      name:
        type: string
      namespace:
        description: required to save in RDB
        type: string
      netBwGbps:
        type: integer
      numCore:
        type: integer
      numGpu:
        type: integer
      numStorage:
        type: integer
      numvCPU:
        type: integer
      orderInFilteredResult:
        type: integer
      osType:
        type: string
      providerName:
        type: string
      regionName:
        type: string
      rootDiskSize:
        type: string
      rootDiskType:
        type: string
      storageGiB:
        type: integer
      systemLabel:
        description: SystemLabel is for describing the MCIR in a keyword (any string
          can be used) for special System purpose
        example: Managed by CB-Tumblebug
        type: string
    type: object
  mcir.TbSpecReq:
    properties:
      connectionName:
        type: string
      cspSpecName:
        type: string
      description:
        type: string
      name:
        type: string
    required:
    - connectionName
    - cspSpecName
    - name
    type: object
  mcir.TbSshKeyInfo:
    properties:
      associatedObjectList:
        items:
          type: string
        type: array
      connectionName:
        type: string
      cspSshKeyId:
        description: CspSshKeyId used for CSP-native identifier (either Name or ID)
        type: string
      cspSshKeyName:
        description: CspSshKeyName used for CB-Spider identifier
        type: string
      description:
        type: string
      fingerprint:
        type: string
      id:
        type: string
      isAutoGenerated:
        type: boolean
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        type: string
      privateKey:
        type: string
      publicKey:
        type: string
      systemLabel:
        description: SystemLabel is for describing the MCIR in a keyword (any string
          can be used) for special System purpose
        example: Managed by CB-Tumblebug
        type: string
      username:
        type: string
      verifiedUsername:
        type: string
    type: object
  mcir.TbSshKeyReq:
    properties:
      connectionName:
        type: string
      cspSshKeyId:
        description: |-
          Fields for "Register existing SSH keys" feature
          CspSshKeyId is required to register object from CSP (option=register)
        type: string
      description:
        type: string
      fingerprint:
        type: string
      name:
        type: string
      privateKey:
        type: string
      publicKey:
        type: string
      username:
        type: string
      verifiedUsername:
        type: string
    required:
    - connectionName
    - name
    type: object
  mcir.TbSubnetInfo:
    properties:
      description:
        type: string
      id:
        type: string
      ipv4_CIDR:
        type: string
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        type: string
    required:
    - ipv4_CIDR
    - name
    type: object
  mcir.TbSubnetReq:
    properties:
      description:
        type: string
      ipv4_CIDR:
        type: string
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        type: string
    required:
    - ipv4_CIDR
    - name
    type: object
  mcir.TbVNetInfo:
    properties:
      associatedObjectList:
        items:
          type: string
        type: array
      cidrBlock:
        type: string
      connectionName:
        type: string
      cspVNetId:
        type: string
      cspVNetName:
        type: string
      description:
        type: string
      id:
        type: string
      isAutoGenerated:
        type: boolean
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        type: string
      status:
        type: string
      subnetInfoList:
        items:
          $ref: '#/definitions/mcir.TbSubnetInfo'
        type: array
      systemLabel:
        description: SystemLabel is for describing the MCIR in a keyword (any string
          can be used) for special System purpose
        example: Managed by CB-Tumblebug
        type: string
    type: object
  mcir.TbVNetReq:
    properties:
      cidrBlock:
        type: string
      connectionName:
        type: string
      cspVNetId:
        type: string
      description:
        type: string
      name:
        type: string
      subnetInfoList:
        items:
          $ref: '#/definitions/mcir.TbSubnetReq'
        type: array
    required:
    - connectionName
    - name
    type: object
  mcis.AgentInstallContent:
    properties:
      mcisId:
        type: string
      result:
        type: string
      vmId:
        type: string
      vmIp:
        type: string
    type: object
  mcis.AgentInstallContentWrapper:
    properties:
      resultArray:
        items:
          $ref: '#/definitions/mcis.AgentInstallContent'
        type: array
    type: object
  mcis.AutoAction:
    properties:
      actionType:
        type: string
      placementAlgo:
        type: string
      postCommand:
        $ref: '#/definitions/mcis.McisCmdReq'
      vm:
        $ref: '#/definitions/mcis.TbVmInfo'
    type: object
  mcis.AutoCondition:
    properties:
      evaluationPeriod:
        description: evaluationPeriod
        type: string
      evaluationValue:
        items:
          type: string
        type: array
      metric:
        type: string
      operand:
        description: 10, 70, 80, 98, ...
        type: string
      operator:
        description: <, <=, >, >=, ...
        type: string
    type: object
  mcis.BenchmarkInfo:
    properties:
      desc:
        type: string
      elapsed:
        type: string
      result:
        type: string
      resultarray:
        description: struct-element cycle ?
        items:
          $ref: '#/definitions/mcis.BenchmarkInfo'
        type: array
      specid:
        type: string
      unit:
        type: string
    type: object
  mcis.BenchmarkInfoArray:
    properties:
      resultarray:
        items:
          $ref: '#/definitions/mcis.BenchmarkInfo'
        type: array
    type: object
  mcis.CheckMcisDynamicReqInfo:
    properties:
      reqCheck:
        items:
          $ref: '#/definitions/mcis.CheckVmDynamicReqInfo'
        type: array
    required:
    - reqCheck
    type: object
  mcis.CheckVmDynamicReqInfo:
    properties:
      connectionConfigCandidates:
        description: ConnectionConfigCandidates will provide ConnectionConfig options
        items:
          type: string
        type: array
      region:
        $ref: '#/definitions/common.Region'
      systemMessage:
        description: Latest system message such as error message
        example: Failed because ...
        type: string
      vmSpec:
        $ref: '#/definitions/mcir.TbSpecInfo'
    type: object
  mcis.DeploymentPlan:
    properties:
      filter:
        $ref: '#/definitions/mcis.FilterInfo'
      limit:
        enum:
        - "1"
        - "2"
        - '...'
        - "30"
        - '...'
        example: "5"
        type: string
      priority:
        $ref: '#/definitions/mcis.PriorityInfo'
    type: object
  mcis.FilterCondition:
    properties:
      condition:
        items:
          $ref: '#/definitions/mcis.Operation'
        type: array
      metric:
        enum:
        - cpu
        - memory
        - cost
        example: cpu
        type: string
    type: object
  mcis.FilterInfo:
    properties:
      policy:
        items:
          $ref: '#/definitions/mcis.FilterCondition'
        type: array
    type: object
  mcis.InspectResource:
    properties:
      connectionName:
        type: string
      resourceOverview:
        $ref: '#/definitions/mcis.resourceCountOverview'
      resourceType:
        type: string
      resources:
        $ref: '#/definitions/mcis.resourcesByManageType'
      systemMessage:
        type: string
    type: object
  mcis.InspectResourceAllResult:
    properties:
      availableConnection:
        type: integer
      cspOnlyOverview:
        $ref: '#/definitions/mcis.inspectOverview'
      elapsedTime:
        type: integer
      inspectResult:
        items:
          $ref: '#/definitions/mcis.InspectResourceResult'
        type: array
      registeredConnection:
        type: integer
      tumblebugOverview:
        $ref: '#/definitions/mcis.inspectOverview'
    type: object
  mcis.InspectResourceResult:
    properties:
      connectionName:
        type: string
      cspOnlyOverview:
        $ref: '#/definitions/mcis.inspectOverview'
      elapsedTime:
        type: integer
      systemMessage:
        type: string
      tumblebugOverview:
        $ref: '#/definitions/mcis.inspectOverview'
    type: object
  mcis.JSONResult:
    type: object
  mcis.McisCmdReq:
    properties:
      command:
        example: sudo apt-get install ...
        type: string
      userName:
        example: cb-user
        type: string
    required:
    - command
    type: object
  mcis.McisConnectionConfigCandidatesReq:
    properties:
      commonSpec:
        description: CommonSpec is field for id of a spec in common namespace
        example:
        - aws-ap-northeast-2-t2-small
        - gcp-us-west1-g1-small
        items:
          type: string
        type: array
    required:
    - commonSpec
    type: object
  mcis.McisPolicyInfo:
    properties:
      Id:
        description: MCIS Id (generated ID by the Name)
        type: string
      Name:
        description: MCIS Name (for request)
        type: string
      actionLog:
        type: string
      description:
        type: string
      policy:
        items:
          $ref: '#/definitions/mcis.Policy'
        type: array
    type: object
  mcis.McisStatusInfo:
    properties:
      id:
        type: string
      installMonAgent:
        description: InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no]
          default:yes)
        example: '[yes, no]'
        type: string
      label:
        description: Label is for describing the mcis in a keyword (any string can
          be used)
        example: User custom label
        type: string
      masterIp:
        example: 32.201.134.113
        type: string
      masterSSHPort:
        type: string
      masterVmId:
        example: vm-asiaeast1-cb-01
        type: string
      name:
        type: string
      status:
        type: string
      statusCount:
        $ref: '#/definitions/mcis.StatusCountInfo'
      systemLabel:
        description: SystemLabel is for describing the mcis in a keyword (any string
          can be used) for special System purpose
        example: Managed by CB-Tumblebug
        type: string
      targetAction:
        type: string
      targetStatus:
        type: string
      vm:
        items:
          $ref: '#/definitions/mcis.TbVmStatusInfo'
        type: array
    type: object
  mcis.MonResultSimple:
    properties:
      err:
        type: string
      metric:
        type: string
      value:
        type: string
      vmId:
        type: string
    type: object
  mcis.MonResultSimpleResponse:
    properties:
      mcisId:
        type: string
      mcisMonitoring:
        items:
          $ref: '#/definitions/mcis.MonResultSimple'
        type: array
      nsId:
        type: string
    type: object
  mcis.NetworkReq:
    properties:
      etcdEndpoints:
        example:
        - PUBLIC_IP_1:2379
        - PUBLIC_IP_2:2379
        - '...'
        items:
          type: string
        type: array
      serviceEndpoint:
        example: localhost:8053
        type: string
    type: object
  mcis.Operation:
    properties:
      operand:
        description: 10, 70, 80, 98, ...
        enum:
        - "4"
        - "8"
        - ..
        example: "4"
        type: string
      operator:
        description: '>=, <=, =='
        enum:
        - '>='
        - <=
        - ==
        example: <=
        type: string
    type: object
  mcis.ParameterKeyVal:
    properties:
      key:
        description: coordinate
        enum:
        - coordinateClose
        - coordinateWithin
        - coordinateFair
        example: coordinateClose
        type: string
      val:
        description: '["Latitude,Longitude","12,543",..,"31,433"]'
        example:
        - 44.146838/-116.411403
        items:
          type: string
        type: array
    type: object
  mcis.Policy:
    properties:
      autoAction:
        $ref: '#/definitions/mcis.AutoAction'
      autoCondition:
        $ref: '#/definitions/mcis.AutoCondition'
      status:
        type: string
    type: object
  mcis.PriorityCondition:
    properties:
      metric:
        description: location,cost,latency
        enum:
        - location
        - cost
        - latency
        example: location
        type: string
      parameter:
        items:
          $ref: '#/definitions/mcis.ParameterKeyVal'
        type: array
      weight:
        description: "0.3"
        enum:
        - "0.1"
        - "0.2"
        - '...'
        example: "0.3"
        type: string
    type: object
  mcis.PriorityInfo:
    properties:
      policy:
        items:
          $ref: '#/definitions/mcis.PriorityCondition'
        type: array
    type: object
  mcis.RegionInfo:
    properties:
      region:
        type: string
      zone:
        type: string
    type: object
  mcis.RegisterResourceAllResult:
    properties:
      availableConnection:
        type: integer
      elapsedTime:
        type: integer
      registerationOverview:
        $ref: '#/definitions/mcis.registerationOverview'
      registerationResult:
        items:
          $ref: '#/definitions/mcis.RegisterResourceResult'
        type: array
      registeredConnection:
        type: integer
    type: object
  mcis.RegisterResourceResult:
    properties:
      connectionName:
        type: string
      elapsedTime:
        type: integer
      registerationOutputs:
        $ref: '#/definitions/common.IdList'
      registerationOverview:
        $ref: '#/definitions/mcis.registerationOverview'
      systemMessage:
        type: string
    type: object
  mcis.RestGetAllBenchmarkRequest:
    properties:
      host:
        type: string
    type: object
  mcis.RestGetAllMcisPolicyResponse:
    properties:
      mcisPolicy:
        items:
          $ref: '#/definitions/mcis.McisPolicyInfo'
        type: array
    type: object
  mcis.RestGetAllMcisResponse:
    properties:
      mcis:
        items:
          $ref: '#/definitions/mcis.TbMcisInfo'
        type: array
    type: object
  mcis.RestGetAllMcisStatusResponse:
    properties:
      mcis:
        items:
          $ref: '#/definitions/mcis.McisStatusInfo'
        type: array
    type: object
  mcis.RestGetBenchmarkRequest:
    properties:
      host:
        type: string
    type: object
  mcis.RestPostCmdMcisResponse:
    properties:
      mcisId:
        type: string
      result:
        type: string
      vmId:
        type: string
      vmIp:
        type: string
    type: object
  mcis.RestPostCmdMcisResponseWrapper:
    properties:
      resultArray:
        items:
          $ref: '#/definitions/mcis.RestPostCmdMcisResponse'
        type: array
    type: object
  mcis.RestPostCmdMcisVmResponse:
    properties:
      result:
        type: string
    type: object
  mcis.SpiderVMInfo:
    properties:
      cspid:
        description: VM ID given by CSP (required for registering VM)
        type: string
      iid:
        $ref: '#/definitions/common.IID'
        description: Fields for response
      imageIId:
        $ref: '#/definitions/common.IID'
      imageName:
        type: string
      keyPairIId:
        $ref: '#/definitions/common.IID'
      keyPairName:
        type: string
      keyValueList:
        items:
          $ref: '#/definitions/common.KeyValue'
        type: array
      name:
        description: Fields for request
        type: string
      networkInterface:
        description: ex) eth0
        type: string
      privateDNS:
        type: string
      privateIP:
        type: string
      publicDNS:
        type: string
      publicIP:
        type: string
      region:
        $ref: '#/definitions/mcis.RegionInfo'
        description: ex) {us-east1, us-east1-c} or {ap-northeast-2}
      rootDeviceName:
        description: '"/dev/sda1", ...'
        type: string
      rootDiskSize:
        description: '"default", "50", "1000" (GB)'
        type: string
      rootDiskType:
        description: '"SSD(gp2)", "Premium SSD", ...'
        type: string
      securityGroupIIds:
        description: AWS, ex) sg-0b7452563e1121bb6
        items:
          $ref: '#/definitions/common.IID'
        type: array
      securityGroupNames:
        items:
          type: string
        type: array
      sshaccessPoint:
        type: string
      startTime:
        description: 'Timezone: based on cloud-barista server location.'
        type: string
      subnetIID:
        $ref: '#/definitions/common.IID'
        description: AWS, ex) subnet-8c4a53e4
      subnetName:
        type: string
      vmblockDisk:
        description: ex)
        type: string
      vmbootDisk:
        description: Deprecated soon // ex) /dev/sda1
        type: string
      vmspecName:
        description: Fields for both request and response
        type: string
      vmuserId:
        description: ex) user1
        type: string
      vmuserPasswd:
        type: string
      vpcIID:
        $ref: '#/definitions/common.IID'
      vpcname:
        type: string
    type: object
  mcis.StatusCountInfo:
    properties:
      countCreating:
        description: CountCreating is for counting Creating
        type: integer
      countFailed:
        description: CountFailed is for counting Failed
        type: integer
      countRebooting:
        description: CountRebooting is for counting Rebooting
        type: integer
      countResuming:
        description: CountResuming is for counting Resuming
        type: integer
      countRunning:
        description: CountRunning is for counting Running
        type: integer
      countSuspended:
        description: CountSuspended is for counting Suspended
        type: integer
      countSuspending:
        description: CountSuspending is for counting Suspending
        type: integer
      countTerminated:
        description: CountTerminated is for counting Terminated
        type: integer
      countTerminating:
        description: CountTerminating is for counting Terminating
        type: integer
      countTotal:
        description: CountTotal is for Total VMs
        type: integer
      countUndefined:
        description: CountUndefined is for counting Undefined
        type: integer
    type: object
  mcis.TbMcisDynamicReq:
    properties:
      description:
        example: Made in CB-TB
        type: string
      installMonAgent:
        default: "yes"
        description: InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no]
          default:yes)
        enum:
        - "yes"
        - "no"
        example: "no"
        type: string
      label:
        description: Label is for describing the mcis in a keyword (any string can
          be used)
        example: DynamicVM
        type: string
      name:
        example: mcis01
        type: string
      systemLabel:
        description: SystemLabel is for describing the mcis in a keyword (any string
          can be used) for special System purpose
        example: ""
        type: string
      vm:
        items:
          $ref: '#/definitions/mcis.TbVmDynamicReq'
        type: array
    required:
    - name
    - vm
    type: object
  mcis.TbMcisInfo:
    properties:
      configureCloudAdaptiveNetwork:
        default: "no"
        description: ConfigureCloudAdaptiveNetwork is an option to configure Cloud
          Adaptive Network (CLADNet) ([yes/no] default:yes)
        enum:
        - "yes"
        - "no"
        example: "yes"
        type: string
      description:
        type: string
      id:
        type: string
      installMonAgent:
        default: "yes"
        description: InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no]
          default:yes)
        enum:
        - "yes"
        - "no"
        example: "yes"
        type: string
      label:
        description: Label is for describing the mcis in a keyword (any string can
          be used)
        example: User custom label
        type: string
      name:
        type: string
      placementAlgo:
        type: string
      status:
        type: string
      statusCount:
        $ref: '#/definitions/mcis.StatusCountInfo'
      systemLabel:
        description: SystemLabel is for describing the mcis in a keyword (any string
          can be used) for special System purpose
        example: Managed by CB-Tumblebug
        type: string
      targetAction:
        type: string
      targetStatus:
        type: string
      vm:
        items:
          $ref: '#/definitions/mcis.TbVmInfo'
        type: array
    type: object
  mcis.TbMcisReq:
    properties:
      description:
        example: Made in CB-TB
        type: string
      installMonAgent:
        default: "yes"
        description: InstallMonAgent Option for CB-Dragonfly agent installation ([yes/no]
          default:yes)
        enum:
        - "yes"
        - "no"
        example: "no"
        type: string
      label:
        description: Label is for describing the mcis in a keyword (any string can
          be used)
        example: custom tag
        type: string
      name:
        example: mcis01
        type: string
      placementAlgo:
        type: string
      systemLabel:
        description: SystemLabel is for describing the mcis in a keyword (any string
          can be used) for special System purpose
        example: ""
        type: string
      vm:
        items:
          $ref: '#/definitions/mcis.TbVmReq'
        type: array
    required:
    - name
    - vm
    type: object
  mcis.TbVmDynamicReq:
    properties:
      commonImage:
        description: CommonImage is field for id of a image in common namespace
        example: ubuntu18.04
        type: string
      commonSpec:
        description: CommonSpec is field for id of a spec in common namespace
        example: aws-ap-northeast-2-t2-small
        type: string
      connectionName:
        description: |-
          if ConnectionName is given, the VM tries to use associtated credential.
          if not, it will use predefined ConnectionName in Spec objects
        type: string
      description:
        example: Description
        type: string
      label:
        example: DynamicVM
        type: string
      name:
        description: VM name or VM group name if is (not empty) && (> 0). If it is
          a group, actual VM name will be generated with -N postfix.
        example: vm01
        type: string
      rootDiskSize:
        description: '"default", Integer (GB): ["50", ..., "1000"]'
        example: default, 30, 42, ...
        type: string
      rootDiskType:
        description: '"", "default", "TYPE1", AWS: ["standard", "gp2", "gp3"], Azure:
          ["PremiumSSD", "StandardSSD", "StandardHHD"], GCP: ["pd-standard", "pd-balanced",
          "pd-ssd", "pd-extreme"], ALIBABA: ["cloud_efficiency", "cloud", "cloud_essd"],
          TENCENT: ["CLOUD_PREMIUM", "CLOUD_SSD"]'
        example: default, TYPE1, ...
        type: string
      vmGroupSize:
        description: if vmGroupSize is (not empty) && (> 0), VM group will be gernetad.
          VMs will be created accordingly.
        example: "3"
        type: string
    required:
    - commonImage
    - commonSpec
    type: object
  mcis.TbVmInfo:
    properties:
      connectionName:
        type: string
      createdTime:
        description: Created time
        example: "2022-11-10 23:00:00"
        type: string
      cspViewVmDetail:
        $ref: '#/definitions/mcis.SpiderVMInfo'
      description:
        type: string
      id:
        type: string
      idByCSP:
        description: CSP managed ID or Name
        type: string
      imageId:
        type: string
      label:
        type: string
      location:
        $ref: '#/definitions/common.GeoLocation'
      monAgentStatus:
        description: Montoring agent status
        example: '[installed, notInstalled, failed]'
        type: string
      name:
        type: string
      networkAgentStatus:
        description: NetworkAgent status
        example: '[notInstalled, installing, installed, failed]'
        type: string
      privateDNS:
        type: string
      privateIP:
        type: string
      publicDNS:
        type: string
      publicIP:
        type: string
      region:
        $ref: '#/definitions/mcis.RegionInfo'
        description: AWS, ex) {us-east1, us-east1-c} or {ap-northeast-2}
      rootDeviceName:
        type: string
      rootDiskSize:
        type: string
      rootDiskType:
        type: string
      securityGroupIds:
        items:
          type: string
        type: array
      specId:
        type: string
      sshKeyId:
        type: string
      sshPort:
        type: string
      status:
        description: Required by CB-Tumblebug
        type: string
      subnetId:
        type: string
      systemMessage:
        description: Latest system message such as error message
        example: Failed because ...
        type: string
      targetAction:
        type: string
      targetStatus:
        type: string
      vNetId:
        type: string
      vmBlockDisk:
        type: string
      vmBootDisk:
        description: ex) /dev/sda1
        type: string
      vmGroupId:
        description: defined if the VM is in a group
        type: string
      vmUserAccount:
        type: string
      vmUserPassword:
        type: string
    type: object
  mcis.TbVmReq:
    properties:
      connectionName:
        example: testcloud01-seoul
        type: string
      description:
        example: Description
        type: string
      idByCsp:
        description: CSP managed ID or Name (required for option=register)
        example: i-014fa6ede6ada0b2c
        type: string
      imageId:
        type: string
      label:
        type: string
      name:
        description: VM name or VM group name if is (not empty) && (> 0). If it is
          a group, actual VM name will be generated with -N postfix.
        example: vm01
        type: string
      rootDiskSize:
        description: '"default", Integer (GB): ["50", ..., "1000"]'
        example: default, 30, 42, ...
        type: string
      rootDiskType:
        description: '"", "default", "TYPE1", AWS: ["standard", "gp2", "gp3"], Azure:
          ["PremiumSSD", "StandardSSD", "StandardHHD"], GCP: ["pd-standard", "pd-balanced",
          "pd-ssd", "pd-extreme"], ALIBABA: ["cloud_efficiency", "cloud", "cloud_ssd"],
          TENCENT: ["CLOUD_PREMIUM", "CLOUD_SSD"]'
        example: default, TYPE1, ...
        type: string
      securityGroupIds:
        items:
          type: string
        type: array
      specId:
        type: string
      sshKeyId:
        type: string
      subnetId:
        type: string
      vNetId:
        type: string
      vmGroupSize:
        description: if vmGroupSize is (not empty) && (> 0), VM group will be gernetad.
          VMs will be created accordingly.
        example: "3"
        type: string
      vmUserAccount:
        type: string
      vmUserPassword:
        type: string
    required:
    - connectionName
    - imageId
    - name
    - securityGroupIds
    - specId
    - sshKeyId
    - subnetId
    - vNetId
    type: object
  mcis.TbVmStatusInfo:
    properties:
      createdTime:
        description: Created time
        example: "2022-11-10 23:00:00"
        type: string
      cspVmId:
        type: string
      id:
        type: string
      location:
        $ref: '#/definitions/common.GeoLocation'
      monAgentStatus:
        description: Montoring agent status
        example: '[installed, notInstalled, failed]'
        type: string
      name:
        type: string
      nativeStatus:
        type: string
      privateIp:
        type: string
      publicIp:
        type: string
      sshPort:
        type: string
      status:
        type: string
      systemMessage:
        description: Latest system message such as error message
        example: Failed because ...
        type: string
      targetAction:
        type: string
      targetStatus:
        type: string
    type: object
  mcis.inspectOverview:
    properties:
      securityGroup:
        type: integer
      sshKey:
        type: integer
      vNet:
        type: integer
      vm:
        type: integer
    type: object
  mcis.registerationOverview:
    properties:
      failed:
        type: integer
      securityGroup:
        type: integer
      sshKey:
        type: integer
      vNet:
        type: integer
      vm:
        type: integer
    type: object
  mcis.resourceCountOverview:
    properties:
      onCspOnly:
        type: integer
      onCspTotal:
        type: integer
      onSpider:
        type: integer
      onTumblebug:
        type: integer
    type: object
  mcis.resourceOnCsp:
    properties:
      count:
        type: integer
      info:
        items:
          $ref: '#/definitions/mcis.resourceOnCspInfo'
        type: array
    type: object
  mcis.resourceOnCspInfo:
    properties:
      idByCsp:
        type: string
      refNameOrId:
        type: string
    type: object
  mcis.resourceOnSpider:
    properties:
      count:
        type: integer
      info:
        items:
          $ref: '#/definitions/mcis.resourceOnSpiderInfo'
        type: array
    type: object
  mcis.resourceOnSpiderInfo:
    properties:
      idByCsp:
        type: string
      idBySp:
        type: string
    type: object
  mcis.resourceOnTumblebug:
    properties:
      count:
        type: integer
      info:
        items:
          $ref: '#/definitions/mcis.resourceOnTumblebugInfo'
        type: array
    type: object
  mcis.resourceOnTumblebugInfo:
    properties:
      idByCsp:
        type: string
      idByTb:
        type: string
      mcisId:
        type: string
      nsId:
        type: string
      objectKey:
        type: string
    type: object
  mcis.resourcesByManageType:
    properties:
      onCspOnly:
        $ref: '#/definitions/mcis.resourceOnCsp'
      onCspTotal:
        $ref: '#/definitions/mcis.resourceOnCsp'
      onSpider:
        $ref: '#/definitions/mcis.resourceOnSpider'
      onTumblebug:
        $ref: '#/definitions/mcis.resourceOnTumblebug'
    type: object
info:
  contact:
    email: contact-to-cloud-barista@googlegroups.com
    name: API Support
    url: http://cloud-barista.github.io
  description: CB-Tumblebug REST API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: CB-Tumblebug REST API
  version: latest
paths:
  /{nsId}/checkResource/{resourceType}/{resourceId}:
    get:
      consumes:
      - application/json
      description: Check resources' existence
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Resource Type
        in: path
        name: resourceType
        required: true
        type: string
      - description: Resource ID
        in: path
        name: resourceId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Check resources' existence
      tags:
      - '[Infra resource] MCIR Common'
  /config:
    delete:
      consumes:
      - application/json
      description: Init all configs
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Init all configs
      tags:
      - '[Admin] System environment'
    get:
      consumes:
      - application/json
      description: List all configs
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.RestGetAllConfigResponse'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all configs
      tags:
      - '[Admin] System environment'
    post:
      consumes:
      - application/json
      description: Create or Update config (SPIDER_REST_URL, DRAGONFLY_REST_URL, ...)
      parameters:
      - description: Key and Value for configuration
        in: body
        name: config
        required: true
        schema:
          $ref: '#/definitions/common.ConfigReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.ConfigInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create or Update config
      tags:
      - '[Admin] System environment'
  /config/{configId}:
    delete:
      consumes:
      - application/json
      description: Init config
      parameters:
      - description: Config ID
        in: path
        name: configId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.ConfigInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Init config
      tags:
      - '[Admin] System environment'
    get:
      consumes:
      - application/json
      description: Get config
      parameters:
      - description: Config ID
        in: path
        name: configId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.ConfigInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get config
      tags:
      - '[Admin] System environment'
  /connConfig:
    get:
      consumes:
      - application/json
      description: List all registered ConnConfig
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.ConnConfigList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all registered ConnConfig
      tags:
      - '[Admin] Multi-Cloud environment configuration'
  /connConfig/{connConfigName}:
    get:
      consumes:
      - application/json
      description: Get registered ConnConfig info
      parameters:
      - description: Name of connection config (cloud config)
        in: path
        name: connConfigName
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.ConnConfig'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get registered ConnConfig info
      tags:
      - '[Admin] Multi-Cloud environment configuration'
  /health:
    get:
      consumes:
      - application/json
      description: Check Tumblebug is alive
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Check Tumblebug is alive
      tags:
      - '[Admin] System management'
  /inspectResources:
    post:
      consumes:
      - application/json
      description: Inspect Resources (vNet, securityGroup, sshKey, vm) registered
        in CB-Tumblebug, CB-Spider, CSP
      parameters:
      - description: Specify connectionName and resource type
        in: body
        name: connectionName
        required: true
        schema:
          $ref: '#/definitions/common.RestInspectResourcesRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.InspectResource'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Inspect Resources (vNet, securityGroup, sshKey, vm) registered in CB-Tumblebug,
        CB-Spider, CSP
      tags:
      - '[Admin] System management'
  /inspectResourcesOverview:
    get:
      consumes:
      - application/json
      description: Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered
        in CB-Tumblebug and CSP for all connections
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.InspectResourceAllResult'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Inspect Resources Overview (vNet, securityGroup, sshKey, vm) registered
        in CB-Tumblebug and CSP for all connections
      tags:
      - '[Admin] System management'
  /loadCommonResource:
    get:
      consumes:
      - application/json
      description: Load Common Resources from internal asset files (Spec, Image)
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.IdList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Load Common Resources from internal asset files
      tags:
      - '[Admin] Multi-Cloud environment configuration'
  /lookupImage:
    post:
      consumes:
      - application/json
      description: Lookup image
      parameters:
      - description: Specify connectionName & cspImageId
        in: body
        name: lookupImageReq
        required: true
        schema:
          $ref: '#/definitions/mcir.RestLookupImageRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.SpiderImageInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Lookup image
      tags:
      - '[Infra resource] MCIR Common'
  /lookupImages:
    post:
      consumes:
      - application/json
      description: Lookup image list
      parameters:
      - description: Specify connectionName
        in: body
        name: lookupImagesReq
        required: true
        schema:
          $ref: '#/definitions/common.TbConnectionName'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.SpiderImageList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Lookup image list
      tags:
      - '[Infra resource] MCIR Common'
  /lookupSpec:
    post:
      consumes:
      - application/json
      description: Lookup spec
      parameters:
      - description: Specify connectionName & cspSpecName
        in: body
        name: lookupSpecReq
        required: true
        schema:
          $ref: '#/definitions/mcir.RestLookupSpecRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.SpiderSpecInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Lookup spec
      tags:
      - '[Infra resource] MCIR Common'
  /lookupSpecs:
    post:
      consumes:
      - application/json
      description: Lookup spec list
      parameters:
      - description: Specify connectionName
        in: body
        name: lookupSpecsReq
        required: true
        schema:
          $ref: '#/definitions/common.TbConnectionName'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.SpiderSpecList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Lookup spec list
      tags:
      - '[Infra resource] MCIR Common'
  /mcisDynamicCheckRequest:
    post:
      consumes:
      - application/json
      description: Check available ConnectionConfig list before create MCIS Dynamically
        from common spec and image
      parameters:
      - description: Details for MCIS dynamic request information
        in: body
        name: mcisReq
        required: true
        schema:
          $ref: '#/definitions/mcis.McisConnectionConfigCandidatesReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.CheckMcisDynamicReqInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Check available ConnectionConfig list for creating MCIS Dynamically
      tags:
      - '[Infra service] MCIS Provisioning management'
  /mcisRecommendVm:
    post:
      consumes:
      - application/json
      description: Recommend MCIS plan (filter and priority)
      parameters:
      - description: Recommend MCIS plan (filter and priority)
        in: body
        name: deploymentPlan
        schema:
          $ref: '#/definitions/mcis.DeploymentPlan'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/mcir.TbSpecInfo'
            type: array
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Recommend MCIS plan (filter and priority)
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns:
    delete:
      consumes:
      - application/json
      description: Delete all namespaces
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all namespaces
      tags:
      - '[Namespace] Namespace management'
    get:
      consumes:
      - application/json
      description: List all namespaces or namespaces' ID
      parameters:
      - description: Option
        enum:
        - id
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/common.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/common.RestGetAllNsResponse'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all namespaces or namespaces' ID
      tags:
      - '[Namespace] Namespace management'
    post:
      consumes:
      - application/json
      description: Create namespace
      parameters:
      - description: Details for a new namespace
        in: body
        name: nsReq
        required: true
        schema:
          $ref: '#/definitions/common.NsReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.NsInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create namespace
      tags:
      - '[Namespace] Namespace management'
  /ns/{nsId}:
    delete:
      consumes:
      - application/json
      description: Delete namespace
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete namespace
      tags:
      - '[Namespace] Namespace management'
    get:
      consumes:
      - application/json
      description: Get namespace
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.NsInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get namespace
      tags:
      - '[Namespace] Namespace management'
    put:
      consumes:
      - application/json
      description: Update namespace
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Details to update existing namespace
        in: body
        name: namespace
        required: true
        schema:
          $ref: '#/definitions/common.NsReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.NsInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Update namespace
      tags:
      - '[Namespace] Namespace management'
  /ns/{nsId}/benchmark/mcis/{mcisId}:
    post:
      consumes:
      - application/json
      description: Run MCIS benchmark for a single performance metric and return results
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Host IP address to benchmark
        in: body
        name: hostIP
        required: true
        schema:
          $ref: '#/definitions/mcis.RestGetBenchmarkRequest'
      - description: Benchmark Action to MCIS
        enum:
        - install
        - init
        - cpus
        - cpum
        - memR
        - memW
        - fioR
        - fioW
        - dbR
        - dbW
        - rtt
        - mrtt
        - clean
        in: query
        name: action
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.BenchmarkInfoArray'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Run MCIS benchmark for a single performance metric and return results
      tags:
      - '[Infra service] MCIS Performance benchmarking (WIP)'
  /ns/{nsId}/benchmarkAll/mcis/{mcisId}:
    post:
      consumes:
      - application/json
      description: Run MCIS benchmark for all performance metrics and return results
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Host IP address to benchmark
        in: body
        name: hostIP
        required: true
        schema:
          $ref: '#/definitions/mcis.RestGetAllBenchmarkRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.BenchmarkInfoArray'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Run MCIS benchmark for all performance metrics and return results
      tags:
      - '[Infra service] MCIS Performance benchmarking (WIP)'
  /ns/{nsId}/cmd/mcis/{mcisId}:
    post:
      consumes:
      - application/json
      description: Send a command to specified MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: MCIS Command Request
        in: body
        name: mcisCmdReq
        required: true
        schema:
          $ref: '#/definitions/mcis.McisCmdReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.RestPostCmdMcisResponseWrapper'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Send a command to specified MCIS
      tags:
      - '[Infra service] MCIS Remote command'
  /ns/{nsId}/cmd/mcis/{mcisId}/vm/{vmId}:
    post:
      consumes:
      - application/json
      description: Send a command to specified VM
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - default: vm01
        description: VM ID
        in: path
        name: vmId
        required: true
        type: string
      - description: MCIS Command Request
        in: body
        name: mcisCmdReq
        required: true
        schema:
          $ref: '#/definitions/mcis.McisCmdReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.RestPostCmdMcisVmResponse'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Send a command to specified VM
      tags:
      - '[Infra service] MCIS Remote command'
  /ns/{nsId}/control/mcis/{mcisId}:
    get:
      consumes:
      - application/json
      description: Control the lifecycle of MCIS (refine, suspend, resume, reboot,
        terminate)
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Action to MCIS
        enum:
        - suspend
        - resume
        - reboot
        - terminate
        - refine
        in: query
        name: action
        required: true
        type: string
      - description: Force control to skip checking controllable status
        enum:
        - "false"
        - "true"
        in: query
        name: force
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Control the lifecycle of MCIS (refine, suspend, resume, reboot, terminate)
      tags:
      - '[Infra service] MCIS Control lifecycle'
  /ns/{nsId}/control/mcis/{mcisId}/vm/{vmId}:
    get:
      consumes:
      - application/json
      description: Control the lifecycle of VM (suspend, resume, reboot, terminate)
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - default: vm01
        description: VM ID
        in: path
        name: vmId
        required: true
        type: string
      - description: Action to MCIS
        enum:
        - suspend
        - resume
        - reboot
        - terminate
        in: query
        name: action
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Control the lifecycle of VM (suspend, resume, reboot, terminate)
      tags:
      - '[Infra service] MCIS Control lifecycle'
  /ns/{nsId}/defaultResources:
    delete:
      consumes:
      - application/json
      description: Delete all Default Resource Objects in the given namespace
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.IdList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all Default Resource Objects in the given namespace
      tags:
      - '[Infra resource] MCIR Common'
  /ns/{nsId}/installBenchmarkAgent/mcis/{mcisId}:
    post:
      consumes:
      - application/json
      description: Install the benchmark agent to specified MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: MCIS Command Request
        in: body
        name: mcisCmdReq
        required: true
        schema:
          $ref: '#/definitions/mcis.McisCmdReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.RestPostCmdMcisResponseWrapper'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Install the benchmark agent to specified MCIS
      tags:
      - '[Infra service] MCIS Performance benchmarking (WIP)'
  /ns/{nsId}/loadDefaultResource:
    get:
      consumes:
      - application/json
      description: Load Default Resource from internal asset file
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option
        enum:
        - all
        - vnet
        - sg
        - sshkey
        in: query
        name: option
        required: true
        type: string
      - default: ""
        description: connectionName of cloud for designated resource
        in: query
        name: connectionName
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Load Default Resource from internal asset file
      tags:
      - '[Infra resource] MCIR Common'
  /ns/{nsId}/mcis:
    delete:
      consumes:
      - application/json
      description: Delete all MCISs
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option for delete MCIS (support force delete)
        enum:
        - force
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all MCISs
      tags:
      - '[Infra service] MCIS Provisioning management'
    get:
      consumes:
      - application/json
      description: List all MCISs or MCISs' ID
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option
        enum:
        - id
        - simple
        - status
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/mcis.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcis.RestGetAllMcisResponse'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
                '[SIMPLE]':
                  $ref: '#/definitions/mcis.RestGetAllMcisResponse'
                '[STATUS]':
                  $ref: '#/definitions/mcis.RestGetAllMcisStatusResponse'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all MCISs or MCISs' ID
      tags:
      - '[Infra service] MCIS Provisioning management'
    post:
      consumes:
      - application/json
      description: Create MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Details for an MCIS object
        in: body
        name: mcisReq
        required: true
        schema:
          $ref: '#/definitions/mcis.TbMcisReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.TbMcisInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create MCIS
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns/{nsId}/mcis/{mcisId}:
    delete:
      consumes:
      - application/json
      description: Delete MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Option for delete MCIS (support force delete)
        enum:
        - terminate
        - force
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete MCIS
      tags:
      - '[Infra service] MCIS Provisioning management'
    get:
      consumes:
      - application/json
      description: 'Get MCIS object (option: status, vmID)'
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Option
        enum:
        - default
        - id
        - status
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given action param
          schema:
            allOf:
            - $ref: '#/definitions/mcis.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcis.TbMcisInfo'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
                '[STATUS]':
                  $ref: '#/definitions/mcis.McisStatusInfo'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: 'Get MCIS object (option: status, vmID)'
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns/{nsId}/mcis/{mcisId}/vm:
    post:
      consumes:
      - application/json
      description: Create VM in specified MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Details for an VM object
        in: body
        name: vmReq
        required: true
        schema:
          $ref: '#/definitions/mcis.TbVmReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.TbVmInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create VM in specified MCIS
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns/{nsId}/mcis/{mcisId}/vm/{vmId}:
    delete:
      consumes:
      - application/json
      description: Delete VM in specified MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - default: vm01
        description: VM ID
        in: path
        name: vmId
        required: true
        type: string
      - description: Option for delete VM (support force delete)
        enum:
        - force
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete VM in specified MCIS
      tags:
      - '[Infra service] MCIS Provisioning management'
    get:
      consumes:
      - application/json
      description: Get VM in specified MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - default: vm01
        description: VM ID
        in: path
        name: vmId
        required: true
        type: string
      - description: Option for MCIS
        enum:
        - default
        - status
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/mcis.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcis.TbVmInfo'
                '[STATUS]':
                  $ref: '#/definitions/mcis.TbVmStatusInfo'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get VM in specified MCIS
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns/{nsId}/mcis/{mcisId}/vmgroup:
    post:
      consumes:
      - application/json
      description: Create multiple VMs by VM group in specified MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Details for VM Group
        in: body
        name: vmReq
        required: true
        schema:
          $ref: '#/definitions/mcis.TbVmReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.TbMcisInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create multiple VMs by VM group in specified MCIS
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns/{nsId}/mcisDynamic:
    post:
      consumes:
      - application/json
      description: Create MCIS Dynamically from common spec and image
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Details for MCIS object
        in: body
        name: mcisReq
        required: true
        schema:
          $ref: '#/definitions/mcis.TbMcisDynamicReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.TbMcisInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create MCIS Dynamically
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns/{nsId}/monitoring/install/mcis/{mcisId}:
    post:
      consumes:
      - application/json
      description: Install monitoring agent (CB-Dragonfly agent) to MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Details for an MCIS object
        in: body
        name: mcisInfo
        required: true
        schema:
          $ref: '#/definitions/mcis.McisCmdReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.AgentInstallContentWrapper'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Install monitoring agent (CB-Dragonfly agent) to MCIS
      tags:
      - '[Infra service] MCIS Resource monitor (for developer)'
  /ns/{nsId}/monitoring/mcis/{mcisId}/metric/{metric}:
    get:
      consumes:
      - application/json
      description: Get monitoring data of specified MCIS for specified monitoring
        metric (cpu, memory, disk, network)
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: 'Metric type: cpu, memory, disk, network'
        in: path
        name: metric
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.MonResultSimpleResponse'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get monitoring data of specified MCIS for specified monitoring metric
        (cpu, memory, disk, network)
      tags:
      - '[Infra service] MCIS Resource monitor (for developer)'
  /ns/{nsId}/network/mcis/{mcisId}:
    post:
      consumes:
      - application/json
      description: Configure Cloud Adaptive Network (cb-network agent) to MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Details for the network request body
        in: body
        name: networkReq
        required: true
        schema:
          $ref: '#/definitions/mcis.NetworkReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.AgentInstallContentWrapper'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Configure Cloud Adaptive Network (cb-network agent) to MCIS
      tags:
      - '[Infra service] MCIS Cloud Adaptive Network (for developer)'
    put:
      consumes:
      - application/json
      description: Inject Cloud Information For Cloud Adaptive Network
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Details for the network request body
        in: body
        name: networkReq
        required: true
        schema:
          $ref: '#/definitions/mcis.NetworkReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.AgentInstallContentWrapper'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Inject Cloud Information For Cloud Adaptive Network
      tags:
      - '[Infra service] MCIS Cloud Adaptive Network (for developer)'
  /ns/{nsId}/policy/mcis:
    delete:
      consumes:
      - application/json
      description: Delete all MCIS policies
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all MCIS policies
      tags:
      - '[Infra service] MCIS Auto control policy management (WIP)'
    get:
      consumes:
      - application/json
      description: List all MCIS policies
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.RestGetAllMcisPolicyResponse'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all MCIS policies
      tags:
      - '[Infra service] MCIS Auto control policy management (WIP)'
  /ns/{nsId}/policy/mcis/{mcisId}:
    delete:
      consumes:
      - application/json
      description: Delete MCIS Policy
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete MCIS Policy
      tags:
      - '[Infra service] MCIS Auto control policy management (WIP)'
    get:
      consumes:
      - application/json
      description: Get MCIS Policy
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.McisPolicyInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get MCIS Policy
      tags:
      - '[Infra service] MCIS Auto control policy management (WIP)'
    post:
      consumes:
      - application/json
      description: Create MCIS Automation policy
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: mcis01
        description: MCIS ID
        in: path
        name: mcisId
        required: true
        type: string
      - description: Details for an MCIS object
        in: body
        name: mcisInfo
        required: true
        schema:
          $ref: '#/definitions/mcis.McisPolicyInfo'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.McisPolicyInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create MCIS Automation policy
      tags:
      - '[Infra service] MCIS Auto control policy management (WIP)'
  /ns/{nsId}/registerCspVm:
    post:
      consumes:
      - application/json
      description: Register existing VM in a CSP to Cloud-Barista MCIS
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Details for an MCIS object with existing CSP VM ID
        in: body
        name: mcisReq
        required: true
        schema:
          $ref: '#/definitions/mcis.TbMcisReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.TbMcisInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Register existing VM in a CSP to Cloud-Barista MCIS
      tags:
      - '[Infra service] MCIS Provisioning management'
  /ns/{nsId}/resources/fetchImages:
    post:
      consumes:
      - application/json
      description: Fetch images
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Fetch images
      tags:
      - '[Infra resource] MCIR Image management'
  /ns/{nsId}/resources/fetchSpecs:
    post:
      consumes:
      - application/json
      description: Fetch specs
      parameters:
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Fetch specs
      tags:
      - '[Infra resource] MCIR Spec management'
  /ns/{nsId}/resources/filterSpecs:
    post:
      consumes:
      - application/json
      description: Filter specs
      parameters:
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Filter for filtering specs
        in: body
        name: specFilter
        schema:
          $ref: '#/definitions/mcir.TbSpecInfo'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.RestFilterSpecsResponse'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Filter specs
      tags:
      - '[Infra resource] MCIR Spec management'
  /ns/{nsId}/resources/filterSpecsByRange:
    post:
      consumes:
      - application/json
      description: Filter specs by range
      parameters:
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Filter for range-filtering specs
        in: body
        name: specRangeFilter
        schema:
          $ref: '#/definitions/mcir.FilterSpecsByRangeRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.RestFilterSpecsResponse'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Filter specs by range
      tags:
      - '[Infra resource] MCIR Spec management'
  /ns/{nsId}/resources/image:
    delete:
      consumes:
      - application/json
      description: Delete all images
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: ""
        description: Delete resources containing matched ID-substring only
        in: query
        name: match
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.IdList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all images
      tags:
      - '[Infra resource] MCIR Image management'
    get:
      consumes:
      - application/json
      description: List all images or images' ID
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option
        enum:
        - id
        in: query
        name: option
        type: string
      - description: Field key for filtering (ex:guestOS)
        in: query
        name: filterKey
        type: string
      - description: 'Field value for filtering (ex: Ubuntu18.04)'
        in: query
        name: filterVal
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/mcir.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcir.RestGetAllImageResponse'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all images or images' ID
      tags:
      - '[Infra resource] MCIR Image management'
    post:
      consumes:
      - application/json
      description: Register image
      parameters:
      - description: registerWithInfo or registerWithId
        in: query
        name: registeringMethod
        required: true
        type: string
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Details for an image object
        in: body
        name: imageInfo
        schema:
          $ref: '#/definitions/mcir.TbImageInfo'
      - description: name, connectionName and cspImageId
        in: body
        name: imageId
        schema:
          $ref: '#/definitions/mcir.TbImageReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbImageInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Register image
      tags:
      - '[Infra resource] MCIR Image management'
  /ns/{nsId}/resources/image/{imageId}:
    delete:
      consumes:
      - application/json
      description: Delete image
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Image ID
        in: path
        name: imageId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete image
      tags:
      - '[Infra resource] MCIR Image management'
    get:
      consumes:
      - application/json
      description: Get image
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Image ID
        in: path
        name: imageId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbImageInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get image
      tags:
      - '[Infra resource] MCIR Image management'
    put:
      consumes:
      - application/json
      description: Update image
      parameters:
      - description: Details for an image object
        in: body
        name: imageInfo
        required: true
        schema:
          $ref: '#/definitions/mcir.TbImageInfo'
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Image ID
        in: path
        name: imageId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbImageInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Update image
      tags:
      - '[Infra resource] MCIR Image management'
  /ns/{nsId}/resources/searchImage:
    post:
      consumes:
      - application/json
      description: Search image
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Keywords
        in: body
        name: keywords
        required: true
        schema:
          $ref: '#/definitions/mcir.RestSearchImageRequest'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.RestGetAllImageResponse'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Search image
      tags:
      - '[Infra resource] MCIR Image management'
  /ns/{nsId}/resources/securityGroup:
    delete:
      consumes:
      - application/json
      description: Delete all Security Groups
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: ""
        description: Delete resources containing matched ID-substring only
        in: query
        name: match
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.IdList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all Security Groups
      tags:
      - '[Infra resource] MCIR Security group management'
    get:
      consumes:
      - application/json
      description: List all Security Groups or Security Groups' ID
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option
        enum:
        - id
        in: query
        name: option
        type: string
      - description: 'Field key for filtering (ex: systemLabel)'
        in: query
        name: filterKey
        type: string
      - description: 'Field value for filtering (ex: Registered from CSP resource)'
        in: query
        name: filterVal
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/mcir.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcir.RestGetAllSecurityGroupResponse'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all Security Groups or Security Groups' ID
      tags:
      - '[Infra resource] MCIR Security group management'
    post:
      consumes:
      - application/json
      description: Create Security Group
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: 'Option: [required params for register] connectionName, name,
          vNetId, cspSecurityGroupId'
        enum:
        - register
        in: query
        name: option
        type: string
      - description: Details for an securityGroup object
        in: body
        name: securityGroupReq
        required: true
        schema:
          $ref: '#/definitions/mcir.TbSecurityGroupReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSecurityGroupInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create Security Group
      tags:
      - '[Infra resource] MCIR Security group management'
  /ns/{nsId}/resources/securityGroup/{securityGroupId}:
    delete:
      consumes:
      - application/json
      description: Delete Security Group
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Security Group ID
        in: path
        name: securityGroupId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete Security Group
      tags:
      - '[Infra resource] MCIR Security group management'
    get:
      consumes:
      - application/json
      description: Get Security Group
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Security Group ID
        in: path
        name: securityGroupId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSecurityGroupInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get Security Group
      tags:
      - '[Infra resource] MCIR Security group management'
  /ns/{nsId}/resources/securityGroup/{securityGroupId}/rules:
    delete:
      consumes:
      - application/json
      description: Delete FirewallRules
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: FirewallRules to delete
        in: body
        name: firewallRuleReq
        required: true
        schema:
          $ref: '#/definitions/mcir.TbFirewallRulesWrapper'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSecurityGroupInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete FirewallRules
      tags:
      - '[Infra resource] MCIR Security group management'
    post:
      consumes:
      - application/json
      description: Create FirewallRules
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: FirewallRules to create
        in: body
        name: firewallRuleReq
        required: true
        schema:
          $ref: '#/definitions/mcir.TbFirewallRulesWrapper'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSecurityGroupInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create FirewallRules
      tags:
      - '[Infra resource] MCIR Security group management'
  /ns/{nsId}/resources/spec:
    delete:
      consumes:
      - application/json
      description: Delete all specs
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: ""
        description: Delete resources containing matched ID-substring only
        in: query
        name: match
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.IdList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all specs
      tags:
      - '[Infra resource] MCIR Spec management'
    get:
      consumes:
      - application/json
      description: List all specs or specs' ID
      parameters:
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option
        enum:
        - id
        in: query
        name: option
        type: string
      - description: 'Field key for filtering (ex: providerName)'
        in: query
        name: filterKey
        type: string
      - description: 'Field value for filtering (ex: aws)'
        in: query
        name: filterVal
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/mcir.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcir.RestGetAllSpecResponse'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all specs or specs' ID
      tags:
      - '[Infra resource] MCIR Spec management'
    post:
      consumes:
      - application/json
      description: Register spec
      parameters:
      - description: registerWithInfo or else
        in: query
        name: registeringMethod
        required: true
        type: string
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Details for an spec object
        in: body
        name: specInfo
        schema:
          $ref: '#/definitions/mcir.TbSpecInfo'
      - description: name, connectionName and cspSpecName
        in: body
        name: specName
        schema:
          $ref: '#/definitions/mcir.TbSpecReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSpecInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Register spec
      tags:
      - '[Infra resource] MCIR Spec management'
  /ns/{nsId}/resources/spec/{specId}:
    delete:
      consumes:
      - application/json
      description: Delete spec
      parameters:
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Spec ID
        in: path
        name: specId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete spec
      tags:
      - '[Infra resource] MCIR Spec management'
    get:
      consumes:
      - application/json
      description: Get spec
      parameters:
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Spec ID
        in: path
        name: specId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSpecInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get spec
      tags:
      - '[Infra resource] MCIR Spec management'
    put:
      consumes:
      - application/json
      description: Update spec
      parameters:
      - description: Details for an spec object
        in: body
        name: specInfo
        required: true
        schema:
          $ref: '#/definitions/mcir.TbSpecInfo'
      - default: system-purpose-common-ns
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Spec ID
        in: path
        name: specId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSpecInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Update spec
      tags:
      - '[Infra resource] MCIR Spec management'
  /ns/{nsId}/resources/sshKey:
    delete:
      consumes:
      - application/json
      description: Delete all SSH Keys
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: ""
        description: Delete resources containing matched ID-substring only
        in: query
        name: match
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.IdList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all SSH Keys
      tags:
      - '[Infra resource] MCIR Access key management'
    get:
      consumes:
      - application/json
      description: List all SSH Keys or SSH Keys' ID
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option
        enum:
        - id
        in: query
        name: option
        type: string
      - description: 'Field key for filtering (ex: systemLabel)'
        in: query
        name: filterKey
        type: string
      - description: 'Field value for filtering (ex: Registered from CSP resource)'
        in: query
        name: filterVal
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/mcir.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcir.RestGetAllSshKeyResponse'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all SSH Keys or SSH Keys' ID
      tags:
      - '[Infra resource] MCIR Access key management'
    post:
      consumes:
      - application/json
      description: Create SSH Key
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: 'Option: [required params for register] connectionName, name,
          cspSshKeyId, fingerprint, username, publicKey, privateKey'
        enum:
        - register
        in: query
        name: option
        type: string
      - description: Details for an SSH Key object
        in: body
        name: sshKeyInfo
        required: true
        schema:
          $ref: '#/definitions/mcir.TbSshKeyReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSshKeyInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create SSH Key
      tags:
      - '[Infra resource] MCIR Access key management'
  /ns/{nsId}/resources/sshKey/{sshKeyId}:
    delete:
      consumes:
      - application/json
      description: Delete SSH Key
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: SSH Key ID
        in: path
        name: sshKeyId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete SSH Key
      tags:
      - '[Infra resource] MCIR Access key management'
    get:
      consumes:
      - application/json
      description: Get SSH Key
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: SSH Key ID
        in: path
        name: sshKeyId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSshKeyInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get SSH Key
      tags:
      - '[Infra resource] MCIR Access key management'
    put:
      consumes:
      - application/json
      description: Update SSH Key
      parameters:
      - description: Details for an SSH Key object
        in: body
        name: sshKeyInfo
        required: true
        schema:
          $ref: '#/definitions/mcir.TbSshKeyInfo'
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: SshKey ID
        in: path
        name: sshKeyId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSshKeyInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Update SSH Key
      tags:
      - '[Infra resource] MCIR Access key management'
  /ns/{nsId}/resources/vNet:
    delete:
      consumes:
      - application/json
      description: Delete all VNets
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - default: ""
        description: Delete resources containing matched ID-substring only
        in: query
        name: match
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.IdList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete all VNets
      tags:
      - '[Infra resource] MCIR Network management'
    get:
      consumes:
      - application/json
      description: List all VNets or VNets' ID
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Option
        enum:
        - id
        in: query
        name: option
        type: string
      - description: 'Field key for filtering (ex: cspVNetName)'
        in: query
        name: filterKey
        type: string
      - description: 'Field value for filtering (ex: ns01-alibaba-ap-northeast-1-vpc)'
        in: query
        name: filterVal
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Different return structures by the given option param
          schema:
            allOf:
            - $ref: '#/definitions/mcir.JSONResult'
            - properties:
                '[DEFAULT]':
                  $ref: '#/definitions/mcir.RestGetAllVNetResponse'
                '[ID]':
                  $ref: '#/definitions/common.IdList'
              type: object
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all VNets or VNets' ID
      tags:
      - '[Infra resource] MCIR Network management'
    post:
      consumes:
      - application/json
      description: Create VNet
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: 'Option: [required params for register] connectionName, name,
          cspVNetId'
        enum:
        - register
        in: query
        name: option
        type: string
      - description: Details for an VNet object
        in: body
        name: vNetReq
        required: true
        schema:
          $ref: '#/definitions/mcir.TbVNetReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbVNetInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create VNet
      tags:
      - '[Infra resource] MCIR Network management'
  /ns/{nsId}/resources/vNet/{vNetId}:
    delete:
      consumes:
      - application/json
      description: Delete VNet
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: VNet ID
        in: path
        name: vNetId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete VNet
      tags:
      - '[Infra resource] MCIR Network management'
    get:
      consumes:
      - application/json
      description: Get VNet
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: VNet ID
        in: path
        name: vNetId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbVNetInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get VNet
      tags:
      - '[Infra resource] MCIR Network management'
  /ns/{nsId}/resources/vNet/{vNetId}/subnet:
    post:
      consumes:
      - application/json
      description: Create Subnet
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Details for an Subnet object
        in: body
        name: subnetReq
        required: true
        schema:
          $ref: '#/definitions/mcir.TbSubnetReq'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcir.TbSubnetInfo'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Create Subnet
      tags:
      - '[Infra resource] MCIR Network management'
  /ns/{nsId}/resources/vNet/{vNetId}/subnet/{subnetId}:
    delete:
      consumes:
      - application/json
      description: Delete Subnet
      parameters:
      - default: ns01
        description: Namespace ID
        in: path
        name: nsId
        required: true
        type: string
      - description: Subnet ID
        in: path
        name: subnetId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete Subnet
      tags:
      - '[Infra resource] MCIR Network management'
  /object:
    delete:
      consumes:
      - application/json
      description: Delete an object
      parameters:
      - description: delete object value by key
        in: query
        name: key
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete an object
      tags:
      - '[Admin] System management'
    get:
      consumes:
      - application/json
      description: Get value of an object
      parameters:
      - description: get object value by key
        in: query
        name: key
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get value of an object
      tags:
      - '[Admin] System management'
  /objects:
    delete:
      consumes:
      - application/json
      description: Delete child objects along with the given object
      parameters:
      - description: Delete child objects based on the given key string
        in: query
        name: key
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Delete child objects along with the given object
      tags:
      - '[Admin] System management'
    get:
      consumes:
      - application/json
      description: List all objects for a given key
      parameters:
      - description: retrieve objects by key
        in: query
        name: key
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all objects for a given key
      tags:
      - '[Admin] System management'
  /region:
    get:
      consumes:
      - application/json
      description: List all registered regions
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.RegionList'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: List all registered regions
      tags:
      - '[Admin] Multi-Cloud environment configuration'
  /region/{regionName}:
    get:
      consumes:
      - application/json
      description: Get registered region info
      parameters:
      - description: Name of region to retrieve
        in: path
        name: regionName
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/common.Region'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Get registered region info
      tags:
      - '[Admin] Multi-Cloud environment configuration'
  /registerCspResources:
    post:
      consumes:
      - application/json
      description: Register CSP Native Resources (vNet, securityGroup, sshKey, vm)
        to CB-Tumblebug
      parameters:
      - description: Specify connectionName, NS Id, and MCIS Name
        in: body
        name: Request
        required: true
        schema:
          $ref: '#/definitions/common.RestRegisterCspNativeResourcesRequest'
      - description: Option to specify resourceType
        enum:
        - onlyVm
        - exceptVm
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.RegisterResourceResult'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Register CSP Native Resources (vNet, securityGroup, sshKey, vm) to
        CB-Tumblebug
      tags:
      - '[Admin] System management'
  /registerCspResourcesAll:
    post:
      consumes:
      - application/json
      description: Register CSP Native Resources (vNet, securityGroup, sshKey, vm)
        from all Clouds to CB-Tumblebug
      parameters:
      - description: Specify NS Id and MCIS Name
        in: body
        name: Request
        required: true
        schema:
          $ref: '#/definitions/common.RestRegisterCspNativeResourcesRequestAll'
      - description: Option to specify resourceType
        enum:
        - onlyVm
        - exceptVm
        in: query
        name: option
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/mcis.RegisterResourceAllResult'
        "404":
          description: Not Found
          schema:
            $ref: '#/definitions/common.SimpleMsg'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/common.SimpleMsg'
      summary: Register CSP Native Resources (vNet, securityGroup, sshKey, vm) from
        all Clouds to CB-Tumblebug
      tags:
      - '[Admin] System management'
securityDefinitions:
  BasicAuth:
    type: basic
swagger: "2.0"