swagger: '2.0'
info:
  description: Configuration for Bot Logexpression resource.
  version: 'v2'
  title: bot_log_expression
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: bot_log_expression
    description: Bot Logexpression
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}/macro/v1/security/bot_log_expression:
    get:
      tags:
        - bot_log_expression
      summary: GET all bot_log_expression
      operationId: getall_bot_log_expression
      description: Bot LogExpression Details
      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: args
          type: string
          required: false
          description: "Use this query-parameter to specify arguments.Example:  property-name1:property-value1 "
        - in: query
          name: duration
          type: string
          required: true
          description: "Duration "
          enum:
            - last_1_hour
            - last_1_day
            - last_1_week
            - last_1_month
        - in: query
          name: report_start_time
          type: string
          required: false
          description: Use this query-parameter to specify the start time from which the summary for report is considered
        - in: query
          name: report_end_time
          type: string
          required: false
          description: Use this query-parameter to specify the end time until where summary for report is considered
        - in: query
          name: transaction_id
          type: string
          required: false
          description: Use this query-parameter to specify the transaction id of the bot violation record for which the expression is generated
          enum:
            - transaction id number
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the bot_log_expression 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 bot_log_expression 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 bot_log_expression resources.
          enum:
            - yes
      responses:
        200:
          description:  for bot_log_expression
          schema: 
              $ref: '#/definitions/getbot_log_expressionsResponse'
        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:
  getbot_log_expressionResponse:
    type: object
    required:
      - bot_log_expression
    properties:
      bot_log_expression:
        $ref: '#/definitions/bot_log_expression'
    title: getbot_log_expressionResponse
    example:
      bot_log_expression:
        bot_log_expr_name: "test_log_expr_name"
        bot_log_expr_value: "expr_value"
        bot_log_expr_comment: "comment"
        bot_attack_offset: "15000"
        bot_attack_offset_len: "10"

  getbot_log_expressionsResponse:
    type: object
    required:
      - bot_log_expression
    properties:
      bot_log_expression:
        type: array
        items:
          $ref: '#/definitions/bot_log_expression'
    title: getbot_log_expressionsResponse
    example:
      bot_log_expression:
        bot_log_expr_name: "test_log_expr_name"
        bot_log_expr_value: "expr_value"
        bot_log_expr_comment: "comment"
        bot_attack_offset: "15000"
        bot_attack_offset_len: "10"

  bot_log_expression_readwrite:
    type: object
    properties:
      bot_log_expr_name:
        description: "Log Expression Name"
        type: string
        format: string
      bot_log_expr_value:
        description: "Log Expression Value"
        type: string
        format: string
      bot_log_expr_comment:
        description: "Log Expression Comment"
        type: string
        format: string
      bot_attack_offset:
        description: "Attack Offset"
        type: number
        format: int64
      bot_attack_offset_len:
        description: "Attack Offset Length"
        type: number
        format: int64

  bot_log_expression:
    allOf:
      - $ref: '#/definitions/bot_log_expression_readwrite'

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