swagger: '2.0'
info:
  description: Configuration for Device Score Setting resource.
  version: 'v2'
  title: instance_score_settings
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: instance_score_settings
    description: Device Score Setting
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  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/instance_score_settings:
    get:
      tags:
        - instance_score_settings
      summary: GET all instance_score_settings
      operationId: getall_instance_score_settings
      description: Use this operation to get instance score settings
      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 instance_score_settings 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 instance_score_settings 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 instance_score_settings resources.
          enum:
            - yes
      responses:
        200:
          description:  for instance_score_settings
          schema: 
              $ref: '#/definitions/getinstance_score_settingssResponse'
        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:
  getinstance_score_settingsResponse:
    type: object
    required:
      - instance_score_settings
    properties:
      instance_score_settings:
        $ref: '#/definitions/instance_score_settings'
    title: getinstance_score_settingsResponse
    example:
      instance_score_settings:
        indicator_category: "string_value"
        indicator_notifications_enabled: "false"
        indicator: "string_value"
        indicator_value: "string_value"
        thresholds: [{        indicator_weight: "number_value"
,        indicator: "string_value"
,        id: "string_value"
,        platform: "string_value"
,        instance_type: "string_value"
,        indicator_high: "number_value"
,        indicator_low: "number_value"
,        persistent_factor: "number_value"
}]

  getinstance_score_settingssResponse:
    type: object
    required:
      - instance_score_settings
    properties:
      instance_score_settings:
        type: array
        items:
          $ref: '#/definitions/instance_score_settings'
    title: getinstance_score_settingssResponse
    example:
      instance_score_settings:
        indicator_category: "string_value"
        indicator_notifications_enabled: "false"
        indicator: "string_value"
        indicator_value: "string_value"
        thresholds: [{        indicator_weight: "number_value"
,        indicator: "string_value"
,        id: "string_value"
,        platform: "string_value"
,        instance_type: "string_value"
,        indicator_high: "number_value"
,        indicator_low: "number_value"
,        persistent_factor: "number_value"
}]

  modifyinstance_score_settingsRequest:
    type: object
    required:
      - instance_score_settings
    properties:
      instance_score_settings:
        $ref: '#/definitions/instance_score_settings_readwrite'
    title: modifyinstance_score_settingsRequest
    example:
      instance_score_settings:
        indicator_category: "string_value"
        indicator_notifications_enabled: "false"
        indicator: "string_value"
        indicator_value: "string_value"
        thresholds: [{        indicator_weight: "number_value"
,        indicator: "string_value"
,        id: "string_value"
,        platform: "string_value"
,        instance_type: "string_value"
,        indicator_high: "number_value"
,        indicator_low: "number_value"
,        persistent_factor: "number_value"
}]

  modifyinstance_score_settingsResponse:
    type: object
    required:
      - instance_score_settings
    properties:
      instance_score_settings:
        $ref: '#/definitions/instance_score_settings'
    title: modifyinstance_score_settingsResponse
    example:
      instance_score_settings:
        indicator_category: "string_value"
        indicator_notifications_enabled: "false"
        indicator: "string_value"
        indicator_value: "string_value"
        thresholds: [{        indicator_weight: "number_value"
,        indicator: "string_value"
,        id: "string_value"
,        platform: "string_value"
,        instance_type: "string_value"
,        indicator_high: "number_value"
,        indicator_low: "number_value"
,        persistent_factor: "number_value"
}]

  instance_score_settings_readwrite:
    type: object
    properties:
      indicator_category:
        description: "Category of indicator"
        type: string
        format: string
      indicator_notifications_enabled:
        description: "Flag to check if notifications are enabled"
        type: string
        format: string
      indicator:
        description: "Property or indicator name"
        type: string
        format: string
      indicator_value:
        description: "Indicator Value"
        type: string
        format: string
      thresholds:
        type: array
        items:
          $ref: '#/definitions/instance_score_threshold_readwrite'

  instance_score_settings:
    allOf:
      - $ref: '#/definitions/instance_score_settings_readwrite'

  instance_score_threshold_readwrite:
    type: object
    properties:
      indicator_weight:
        description: "Indicator weight"
        type: number
        format: double
      indicator:
        description: "Property or indicator name"
        type: string
        format: string
      platform:
        description: "Instance Platform"
        type: string
        format: string
      instance_type:
        description: "Instance type"
        type: string
        format: string
      indicator_high:
        description: "Indicator high threshold value"
        type: number
        format: double
      indicator_low:
        description: "Indicator low threshold value"
        type: number
        format: double
      persistent_factor:
        description: "Indicator persistent factor"
        type: number
        format: double

  instance_score_threshold:
    allOf:
      -
        properties:
          id:
            description: Id is system generated key
            type: string
            format: string
      - $ref: '#/definitions/instance_score_threshold_readwrite'

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