swagger: '2.0'
info:
  description: Configuration for Ns event devices summary resource.
  version: 'v2'
  title: devicewise_detail_summary
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: devicewise_detail_summary
    description: Ns event devices summary
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/devicewise_detail_summary:
    get:
      tags:
        - devicewise_detail_summary
      summary: GET all devicewise_detail_summary
      operationId: getall_devicewise_detail_summary
      description: Use this operation to get device summary report.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the devicewise_detail_summary resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the devicewise_detail_summary resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of devicewise_detail_summary resources.
          enum:
            - yes
      responses:
        200:
          description:  for devicewise_detail_summary
          schema: 
              $ref: '#/definitions/getdevicewise_detail_summarysResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getdevicewise_detail_summaryResponse:
    type: object
    required:
      - devicewise_detail_summary
    properties:
      devicewise_detail_summary:
        $ref: '#/definitions/devicewise_detail_summary'
    title: getdevicewise_detail_summaryResponse
    example:
      devicewise_detail_summary:
        instances: "string_value"
        is_agent: "boolean_value"
        memory_usage: "0"
        agent_ip_address: "1.1.1.1"
        total_events: "0"
        cityname: "Bangalore"
        tenant_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        agent_name: "string_value"
        agent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        platform: "string_value"
        vm_cpu_usage: "65.00"
        throughput: "0"
        ip_address: "1.1.1.1"
        instance_state: "Down"
        type: "NS"

  getdevicewise_detail_summarysResponse:
    type: object
    required:
      - devicewise_detail_summary
    properties:
      devicewise_detail_summary:
        type: array
        items:
          $ref: '#/definitions/devicewise_detail_summary'
    title: getdevicewise_detail_summarysResponse
    example:
      devicewise_detail_summary:
        instances: "string_value"
        is_agent: "boolean_value"
        memory_usage: "0"
        agent_ip_address: "1.1.1.1"
        total_events: "0"
        cityname: "Bangalore"
        tenant_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        agent_name: "string_value"
        agent_id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        platform: "string_value"
        vm_cpu_usage: "65.00"
        throughput: "0"
        ip_address: "1.1.1.1"
        instance_state: "Down"
        type: "NS"

  devicewise_detail_summary_readwrite:
    type: object
    properties:
      is_agent:
        description: "Is this device acting as Gateway."
        type: boolean
        format: boolean
      memory_usage:
        description: "memory usage of a device"
        type: number
        format: double
      cityname:
        description: "City Name"
        type: string
        format: string
        maxLength: 255
      agent_name:
        description: "Agent Name"
        type: string
        format: string
        maxLength: 255
      agent_id:
        description: "Agent Id"
        type: string
        format: uuid
        maxLength: 255
      throughput:
        description: "Assign throughput in Mbps to VM Instance"
        type: number
        format: double
      type:
        description: "Type of device, (Xen | NS)"
        type: string
        format: string
        minLength: 1
        maxLength: 64

  devicewise_detail_summary:
    allOf:
      -
        properties:
          instances:
             description: "Total number of devices managed by this agent"
             type: string
             format: string
          agent_ip_address:
             description: "Total number of devices deployed city wise.."
             type: string
             format: ipaddress
          total_events:
             description: "Total minor events."
             type: integer
             format: int32
          tenant_id:
             description: "Tenant Id"
             type: string
             format: uuid
             maxLength: 255
          platform:
             description: "Platform on which Agent is deployed. e.g. XenServer, kubernetes"
             type: string
             format: string
          vm_cpu_usage:
             description: "CPU Usage (%) of VM Instance"
             type: number
             format: double
          ip_address:
             description: "Total number of devices deployed city wise.."
             type: string
             format: ipaddress
          instance_state:
             description: "State of device, UP only if device accessible"
             type: string
             format: string
             minLength: 1
             maxLength: 64
      - $ref: '#/definitions/devicewise_detail_summary_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
