swagger: '2.0'
info:
  description: Configuration for device_info Resource resource.
  version: 'v2'
  title: device_info
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: device_info
    description: device_info Resource
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: server_ip
   in: path
   type: string
   description: Device IP Address
   required: true
  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/device_info:
    get:
      tags:
        - device_info
      summary: GET all device_info
      operationId: getall_device_info
      description: Use this operation to get anomalies
      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 device_info 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 device_info 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 device_info resources.
          enum:
            - yes
      responses:
        200:
          description:  for device_info
          schema: 
              $ref: '#/definitions/getdevice_infosResponse'
        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'

  /massvc/{customerid}/nitro/v2/config/device_info/{server_ip}:
    get:
      tags:
        - device_info
      summary: GET by key for device_info
      operationId: getbykey_device_info
      description: Use this operation to get anomalies
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - $ref: '#/parameters/idParam'
        - 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
      responses:
        200:
          description:  for device_info
          schema: 
              $ref: '#/definitions/getdevice_infoResponse'
        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:
  getdevice_infoResponse:
    type: object
    required:
      - device_info
    properties:
      device_info:
        $ref: '#/definitions/device_info'
    title: getdevice_infoResponse
    example:
      device_info:
        report_end_time: "1580364711"
        anomaly_data: "{anomaly data object}"
        rpt_sample_time: "1580364711"
        duration: "Daily"
        anomaly_count: "0"
        device_name: "ns"
        report_start_time: "1580364711"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        server_ip: "1.1.1.1"

  getdevice_infosResponse:
    type: object
    required:
      - device_info
    properties:
      device_info:
        type: array
        items:
          $ref: '#/definitions/device_info'
    title: getdevice_infosResponse
    example:
      device_info:
        report_end_time: "1580364711"
        anomaly_data: "{anomaly data object}"
        rpt_sample_time: "1580364711"
        duration: "Daily"
        anomaly_count: "0"
        device_name: "ns"
        report_start_time: "1580364711"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        server_ip: "1.1.1.1"

  device_info_readwrite:
    type: object
    properties:
      report_end_time:
        description: "report_end_time for getting the logs in milliseconds"
        type: number
        format: double
      anomaly_data:
        type: array
        items:
          $ref: '#/definitions/anomaly_item_readwrite'
      rpt_sample_time:
        type: number
        format: double
      duration:
        description: "Calculation frequency period daily,weekly etc"
        type: string
        format: string
      anomaly_count:
        description: "Number of anomalies"
        type: integer
        format: int32
      device_name:
        description: "Name of the Device"
        type: string
        format: string
      report_start_time:
        description: "report_start_time for getting the logs in milliseconds"
        type: number
        format: double
      id:
        type: string
        format: uuid

  device_info:
    allOf:
      -
        properties:
          server_ip:
            description: Device IP Address
            type: string
            format: ipaddress
      - $ref: '#/definitions/device_info_readwrite'

  anomaly_item_readwrite:
    type: object
    properties:
      timestamp:
        description: "Timestamp of the anomalous counter"
        type: number
        format: double
      parent_name:
        type: string
        format: string
      value:
        description: "Value of the anomalous counter"
        type: number
        format: double
      counter:
        description: "Name of the anomalous counter"
        type: string
        format: string
      parent_id:
        type: string
        format: string

  anomaly_item:
    allOf:
      -
        properties:
          id:
            type: string
            format: string
      - $ref: '#/definitions/anomaly_item_readwrite'

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