swagger: '2.0'
info:
  description: Configuration for NetScaler Usage information resource.
  version: 'v2'
  title: device_usage
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: device_usage
    description: NetScaler Usage information
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: id
   in: path
   type: string
   description: Id is system generated key
   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_usage:
    get:
      tags:
        - device_usage
      summary: GET all device_usage
      operationId: getall_device_usage
      description: Use this operation to get NetScaler Usage information
      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_usage 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_usage 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_usage resources.
          enum:
            - yes
      responses:
        200:
          description:  for device_usage
          schema: 
              $ref: '#/definitions/getdevice_usagesResponse'
        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_usage/{id}:
    get:
      tags:
        - device_usage
      summary: GET by key for device_usage
      operationId: getbykey_device_usage
      description: Use this operation to get NetScaler Usage information
      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_usage
          schema: 
              $ref: '#/definitions/getdevice_usageResponse'
        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_usageResponse:
    type: object
    required:
      - device_usage
    properties:
      device_usage:
        $ref: '#/definitions/device_usage'
    title: getdevice_usageResponse
    example:
      device_usage:
        license_name: "string_value"
        base_limit: "0"
        license_usage: "0"
        hostname: "test"
        timeslot: "0"
        total_limit: "0"
        timestamp: "0"
        id: "a396e41b-01da-4164-8d83-40b7b8e9379e"
        ip_address: "1.1.1.1"

  getdevice_usagesResponse:
    type: object
    required:
      - device_usage
    properties:
      device_usage:
        type: array
        items:
          $ref: '#/definitions/device_usage'
    title: getdevice_usagesResponse
    example:
      device_usage:
        license_name: "string_value"
        base_limit: "0"
        license_usage: "0"
        hostname: "test"
        timeslot: "0"
        total_limit: "0"
        timestamp: "0"
        id: "a396e41b-01da-4164-8d83-40b7b8e9379e"
        ip_address: "1.1.1.1"

  device_usage_readwrite:
    type: object
    properties:
      base_limit:
        description: "Base limit usage for the user (excluding burst)"
        type: integer
        format: int32
      hostname:
        description: "Host name of the device"
        type: string
        format: string
      timeslot:
        description: "Device usage information at this timestamp"
        type: number
        format: int64
      total_limit:
        description: "Total license limit for the user (including burst)"
        type: integer
        format: int32
      timestamp:
        description: "Max Device usage information per hour at this timestamp"
        type: number
        format: int64

  device_usage:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: string
          license_name:
             description: "License name for the device"
             type: string
             format: string
          license_usage:
             description: "License used by the NetScaler (Bandwidth/vCPU)"
             type: integer
             format: int32
          ip_address:
             description: "IP Address of the device"
             type: string
             format: string
      - $ref: '#/definitions/device_usage_readwrite'

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