swagger: '2.0'
info:
  description: Configuration for Performance Management Reports resource.
  version: 'v2'
  title: perf_reports
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: perf_reports
    description: Performance Management Reports
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: report_name
   in: path
   type: string
   description: Name of Report
   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_reports:
    get:
      tags:
        - perf_reports
      summary: GET all perf_reports
      operationId: getall_perf_reports
      description: Use this operation to get report 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 perf_reports 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_reports 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_reports resources.
          enum:
            - yes
      responses:
        200:
          description:  for perf_reports
          schema: 
              $ref: '#/definitions/getperf_reportssResponse'
        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_reports/{report_name}:
    get:
      tags:
        - perf_reports
      summary: GET by key for perf_reports
      operationId: getbykey_perf_reports
      description: Use this operation to get report 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 perf_reports
          schema: 
              $ref: '#/definitions/getperf_reportsResponse'
        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_reportsResponse:
    type: object
    required:
      - perf_reports
    properties:
      perf_reports:
        $ref: '#/definitions/perf_reports'
    title: getperf_reportsResponse
    example:
      perf_reports:
        report_description: "CPU vs Memory Utilization"
        device_family: "ns"
        entity_type: "lb"
        db_table_name: "perf_res_util_report"
        counter_groups: "system"
        report_name: "Resource Utilization"
        enable_on_devices: "all_devices"

  getperf_reportssResponse:
    type: object
    required:
      - perf_reports
    properties:
      perf_reports:
        type: array
        items:
          $ref: '#/definitions/perf_reports'
    title: getperf_reportssResponse
    example:
      perf_reports:
        report_description: "CPU vs Memory Utilization"
        device_family: "ns"
        entity_type: "lb"
        db_table_name: "perf_res_util_report"
        counter_groups: "system"
        report_name: "Resource Utilization"
        enable_on_devices: "all_devices"

  perf_reports_readwrite:
    type: object
    properties:
      report_description:
        description: "Short Description of the report"
        type: string
        format: string
        minLength: 1
        maxLength: 200
      device_family:
        description: "Device Family of which this report belongs to"
        type: string
        format: string
      entity_type:
        description: "Type of entity (global/lbvserver/service/servicegroup/csvserver/crvserver/authenticationvserver/vpnvserver/gslbvserver)"
        type: string
        format: string
      db_table_name:
        description: "Table Name in DB for the corresponding report"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      counter_groups:
        description: "Counter Group(s) from which the report is generated"
        type: string
        format: string
        minLength: 1
        maxLength: 100
      enable_on_devices:
        description: "On which devices the report is enabled"
        type: string
        format: string
        minLength: 1
        maxLength: 100

  perf_reports:
    allOf:
      -
        properties:
          report_name:
            description: Name of Report
            type: string
            format: string
      - $ref: '#/definitions/perf_reports_readwrite'

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