swagger: '2.0'
info:
  description: Configuration for SNMP Alarm Configurations resource.
  version: 'v2'
  title: snmp_alarm_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: snmp_alarm_config
    description: SNMP Alarm Configurations
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  idParam:
   name: name
   in: path
   type: string
   description: Alarm Name
   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/snmp_alarm_config:
    get:
      tags:
        - snmp_alarm_config
      summary: GET all snmp_alarm_config
      operationId: getall_snmp_alarm_config
      description: Use this operation to get snmp alarm configuration
      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 snmp_alarm_config 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 snmp_alarm_config 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 snmp_alarm_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for snmp_alarm_config
          schema: 
              $ref: '#/definitions/getsnmp_alarm_configsResponse'
        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/snmp_alarm_config/{name}:
    get:
      tags:
        - snmp_alarm_config
      summary: GET by key for snmp_alarm_config
      operationId: getbykey_snmp_alarm_config
      description: Use this operation to get snmp alarm configuration
      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 snmp_alarm_config
          schema: 
              $ref: '#/definitions/getsnmp_alarm_configResponse'
        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'

    put:
      tags:
        - snmp_alarm_config
      summary: PUT for snmp_alarm_config
      operationId: putbykey_snmp_alarm_config
      description: Use this operation to modify snmp alarm configuration
      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
        - in: body
          name: snmp_alarm_config
          description: snmp_alarm_config object
          schema:
              $ref: '#/definitions/modifysnmp_alarm_configRequest'
      responses:
        200:
          description:  for snmp_alarm_config
          schema: 
              $ref: '#/definitions/modifysnmp_alarm_configResponse'
        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:
  getsnmp_alarm_configResponse:
    type: object
    required:
      - snmp_alarm_config
    properties:
      snmp_alarm_config:
        $ref: '#/definitions/snmp_alarm_config'
    title: getsnmp_alarm_configResponse
    example:
      snmp_alarm_config:
        alarm_id: "integer_value"
        enable: "true"
        threshold: "80"
        clear_alarm_oid: "0"
        time: "5"
        name: "cpuUsageHigh"
        severity: "Critical"

  getsnmp_alarm_configsResponse:
    type: object
    required:
      - snmp_alarm_config
    properties:
      snmp_alarm_config:
        type: array
        items:
          $ref: '#/definitions/snmp_alarm_config'
    title: getsnmp_alarm_configsResponse
    example:
      snmp_alarm_config:
        alarm_id: "integer_value"
        enable: "true"
        threshold: "80"
        clear_alarm_oid: "0"
        time: "5"
        name: "cpuUsageHigh"
        severity: "Critical"

  modifysnmp_alarm_configRequest:
    type: object
    required:
      - snmp_alarm_config
    properties:
      snmp_alarm_config:
        $ref: '#/definitions/snmp_alarm_config_readwrite'
    title: modifysnmp_alarm_configRequest
    example:
      snmp_alarm_config:
        enable: "true"
        threshold: "80"
        time: "5"
        severity: "Critical"

  modifysnmp_alarm_configResponse:
    type: object
    required:
      - snmp_alarm_config
    properties:
      snmp_alarm_config:
        $ref: '#/definitions/snmp_alarm_config'
    title: modifysnmp_alarm_configResponse
    example:
      snmp_alarm_config:
        alarm_id: "integer_value"
        enable: "true"
        threshold: "80"
        clear_alarm_oid: "0"
        time: "5"
        name: "cpuUsageHigh"
        severity: "Critical"

  snmp_alarm_config_readwrite:
    type: object
    properties:
      enable:
        description: "Enable Alarm"
        type: boolean
        format: boolean
      threshold:
        description: "Threshold Value for the alarm"
        type: integer
        format: int32
      time:
        description: "Frequency of the alarm in minutes"
        type: integer
        format: int32
      severity:
        description: "Alarm severity. Supported values: Critical, Major, Minor, Warning, Informational "
        type: string
        format: string
        maxLength: 128

  snmp_alarm_config:
    allOf:
      -
        properties:
          name:
            description: Alarm Name
            type: string
            format: string
          clear_alarm_oid:
             description: "Clear alarm Oid"
             type: integer
             format: int32
      - $ref: '#/definitions/snmp_alarm_config_readwrite'

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