swagger: '2.0'
info:
  description: Configuration for Device Counter Table resource.
  version: 'v2'
  title: perf_device_counters
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: perf_device_counters
    description: Device Counter Table
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: counter_group
   in: path
   type: string
   description: Counter Group of which the counter belongs to
   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/perf_device_counters:
    get:
      tags:
        - perf_device_counters
      summary: GET all perf_device_counters
      operationId: getall_perf_device_counters
      description: Get all the counter groups/counters
      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 perf_device_counters 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 perf_device_counters 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 perf_device_counters resources.
          enum:
            - yes
      responses:
        200:
          description:  for perf_device_counters
          schema: 
              $ref: '#/definitions/getperf_device_counterssResponse'
        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/perf_device_counters/{counter_group}:
    get:
      tags:
        - perf_device_counters
      summary: GET by key for perf_device_counters
      operationId: getbykey_perf_device_counters
      description: Get all the counter groups/counters
      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 perf_device_counters
          schema: 
              $ref: '#/definitions/getperf_device_countersResponse'
        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:
  getperf_device_countersResponse:
    type: object
    required:
      - perf_device_counters
    properties:
      perf_device_counters:
        $ref: '#/definitions/perf_device_counters'
    title: getperf_device_countersResponse
    example:
      perf_device_counters:
        device_family: "ns"
        counter_group: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        is_tabular: "f"
        min_ver_supported: "string_value"
        counter_name: "mgmtcpuusagepcnt,pktcpuusagepcnt,memusagepcnt,cpuusage,cpuusagepcnt"

  getperf_device_counterssResponse:
    type: object
    required:
      - perf_device_counters
    properties:
      perf_device_counters:
        type: array
        items:
          $ref: '#/definitions/perf_device_counters'
    title: getperf_device_counterssResponse
    example:
      perf_device_counters:
        device_family: "ns"
        counter_group: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        is_tabular: "f"
        min_ver_supported: "string_value"
        counter_name: "mgmtcpuusagepcnt,pktcpuusagepcnt,memusagepcnt,cpuusage,cpuusagepcnt"

  perf_device_counters_readwrite:
    type: object
    properties:
      device_family:
        description: "Device Family of which the counter belongs to"
        type: string
        format: string
      is_tabular:
        description: "Is Tabular"
        type: boolean
        format: boolean
      min_ver_supported:
        description: "Minimum Version supported by the counter Group"
        type: string
        format: string
        minLength: 1
        maxLength: 100
      counter_name:
        description: "Counter Name"
        type: string
        format: string
        minLength: 1

  perf_device_counters:
    allOf:
      -
        properties:
          counter_group:
            description: Counter Group of which the counter belongs to
            type: string
            format: uuid
      - $ref: '#/definitions/perf_device_counters_readwrite'

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