swagger: '2.0'
info:
  description: Configuration for Counter information resource.
  version: 'v2'
  title: counter_info
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: counter_info
    description: Counter 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/counter_info:
    get:
      tags:
        - counter_info
      summary: GET all counter_info
      operationId: getall_counter_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 counter_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 counter_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 counter_info resources.
          enum:
            - yes
      responses:
        200:
          description:  for counter_info
          schema: 
              $ref: '#/definitions/getcounter_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/counter_info/{id}:
    get:
      tags:
        - counter_info
      summary: GET by key for counter_info
      operationId: getbykey_counter_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 counter_info
          schema: 
              $ref: '#/definitions/getcounter_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:
  getcounter_infoResponse:
    type: object
    required:
      - counter_info
    properties:
      counter_info:
        $ref: '#/definitions/counter_info'
    title: getcounter_infoResponse
    example:
      counter_info:
        report_end_time: "1580897863"
        counter_data: [{        parent_name: "string_value"
,        timestamp: "number_value"
,        value: "number_value"
,        parent_id: "string_value"
,        anomaly: "boolean_value"
}]
        rpt_sample_time: "1580897863"
        duration: "weekly"
        counter_string: "Test Counter"
        counter_name: "ctr1"
        anomaly_count: "1"
        report_start_time: "1580897863"
        app_unit_name: "Test App"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        device_ip: "1.1.1.1"
        server_ip: "1.1.1.1"

  getcounter_infosResponse:
    type: object
    required:
      - counter_info
    properties:
      counter_info:
        type: array
        items:
          $ref: '#/definitions/counter_info'
    title: getcounter_infosResponse
    example:
      counter_info:
        report_end_time: "1580897863"
        counter_data: [{        parent_name: "string_value"
,        timestamp: "number_value"
,        value: "number_value"
,        parent_id: "string_value"
,        anomaly: "boolean_value"
}]
        rpt_sample_time: "1580897863"
        duration: "weekly"
        counter_string: "Test Counter"
        counter_name: "ctr1"
        anomaly_count: "1"
        report_start_time: "1580897863"
        app_unit_name: "Test App"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        device_ip: "1.1.1.1"
        server_ip: "1.1.1.1"

  counter_info_readwrite:
    type: object
    properties:
      counter_data:
        type: array
        items:
          $ref: '#/definitions/counter_item_readwrite'
      duration:
        description: "Calculation frequency period daily,weekly etc"
        type: string
        format: string
      counter_string:
        description: "Display string of the counter"
        type: string
        format: string
      counter_name:
        description: "Name of the counter"
        type: string
        format: string
      anomaly_count:
        description: "Number of anomalies"
        type: integer
        format: int32
      app_unit_name:
        description: "Name of the application"
        type: string
        format: string

  counter_info:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key.
            type: string
            format: uuid
          report_end_time:
             description: "report_end_time for getting the logs in milliseconds"
             type: number
             format: double
          rpt_sample_time:
             description: "Report Sample Time"
             type: number
             format: double
          report_start_time:
             description: "report_start_time for getting the logs in milliseconds"
             type: number
             format: double
      - $ref: '#/definitions/counter_info_readwrite'

  counter_item_readwrite:
    type: object
    properties:
      timestamp:
        description: "Timestamp of the anomalous counter"
        type: number
        format: double
      value:
        description: "Value of the anomalous counter"
        type: number
        format: double
      anomaly:
        description: "If the counter item is anomalous"
        type: boolean
        format: boolean

  counter_item:
    allOf:
      - $ref: '#/definitions/counter_item_readwrite'

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