swagger: '2.0'
info:
  description: Configuration for AF Safety Data Report table resource.
  version: 'v2'
  title: si_safety_signature
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: si_safety_signature
    description: AF Safety Data Report table
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/si_safety_signature:
    get:
      tags:
        - si_safety_signature
      summary: GET all si_safety_signature
      operationId: getall_si_safety_signature
      description: Af Report for Security Insight Device.
      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: cr_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate cr is enabled or not
          enum:
            - 0
            - 1
        - 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: asc
          type: string
          required: false
          description: Use this query-parameter to specify whether the results should be in ascending order or not
          enum:
            - yes
            - no
        - in: query
          name: sla_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate sla is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: order_by
          type: string
          required: false
          description: Use this query-parameter to get the result that is ordered by the given property
          enum:
            - total_attacks
            - sig_rule_id
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - total_attacks
            - sig_rule_id
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the si_safety_signature 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 si_safety_signature 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 si_safety_signature resources.
          enum:
            - yes
      responses:
        200:
          description:  for si_safety_signature
          schema: 
              $ref: '#/definitions/getsi_safety_signaturesResponse'
        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:
  getsi_safety_signatureResponse:
    type: object
    required:
      - si_safety_signature
    properties:
      si_safety_signature:
        $ref: '#/definitions/si_safety_signature'
    title: getsi_safety_signatureResponse
    example:
      si_safety_signature:
        sig_rule_id: "1.0"
        sig_none: "1.0"
        configuration: "Configuration"
        sig_log: "1.0"
        name: "Name"
        profile_not_block_count: "1.0"
        sig_log_count: "1.0"
        sig_stat: "1.0"
        sig_learn: "1.0"
        sig_block_count: "1.0"
        si_device_ip_address: "1.1.1.1"
        sig_safety_index: "1.0"
        si_app_unit_name: "app_1.1.1.1"
        __count: "1.0"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        sig_rule_category: "Name"
        sig_sig_name: "Name"
        sig_block: "1.0"
        profile_sig_disable_count: "1.0"
        sig_stat_count: "1.0"
        sig_rule_logstring: "Name"
        profile_safety_index: "1.0"

  getsi_safety_signaturesResponse:
    type: object
    required:
      - si_safety_signature
    properties:
      si_safety_signature:
        type: array
        items:
          $ref: '#/definitions/si_safety_signature'
    title: getsi_safety_signaturesResponse
    example:
      si_safety_signature:
        sig_rule_id: "1.0"
        sig_none: "1.0"
        configuration: "Configuration"
        sig_log: "1.0"
        name: "Name"
        profile_not_block_count: "1.0"
        sig_log_count: "1.0"
        sig_stat: "1.0"
        sig_learn: "1.0"
        sig_block_count: "1.0"
        si_device_ip_address: "1.1.1.1"
        sig_safety_index: "1.0"
        si_app_unit_name: "app_1.1.1.1"
        __count: "1.0"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        sig_rule_category: "Name"
        sig_sig_name: "Name"
        sig_block: "1.0"
        profile_sig_disable_count: "1.0"
        sig_stat_count: "1.0"
        sig_rule_logstring: "Name"
        profile_safety_index: "1.0"

  si_safety_signature_readwrite:
    type: object
    properties:
      sig_rule_id:
        description: "Signature Rule Id"
        type: number
        format: double
      sig_none:
        description: "Signature None Flags."
        type: number
        format: double
      configuration:
        description: "Profile Security configuration"
        type: string
        format: string
        maxLength: 255
      sig_log:
        description: "Signature Log Flag."
        type: number
        format: double
      name:
        description: "Profile Name"
        type: string
        format: string
        maxLength: 255
      profile_not_block_count:
        description: "Count of Blocked Profile."
        type: number
        format: double
      sig_log_count:
        description: "Count of Signature Logs"
        type: number
        format: double
      sig_stat:
        description: "Signature Stats."
        type: number
        format: double
      sig_learn:
        description: "Signature Learn Flag."
        type: number
        format: double
      sig_block_count:
        description: "Count of Blocked Signatures"
        type: number
        format: double
      sig_safety_index:
        description: "Signature Safety Index."
        type: number
        format: double
      si_app_unit_name:
        description: "AppName"
        type: string
        format: string
        maxLength: 255
      __count:
        description: "Number of records"
        type: number
        format: double
      sig_rule_category:
        description: "Profile sig_rule_category"
        type: string
        format: string
        maxLength: 2550
      sig_sig_name:
        description: "Profile signature name"
        type: string
        format: string
        maxLength: 2550
      sig_block:
        description: "Signature Block Flags."
        type: number
        format: double
      profile_sig_disable_count:
        description: "Count of Disabled Profile Signatures."
        type: number
        format: double
      sig_stat_count:
        description: "Count of Signature Stats."
        type: number
        format: double
      sig_rule_logstring:
        description: "Profile sig_rule_logstring"
        type: string
        format: string
        maxLength: 2550
      profile_safety_index:
        description: "Profile Safety Index."
        type: number
        format: double

  si_safety_signature:
    allOf:
      -
        properties:
          id:
            description: Id is safety profile
            type: string
            format: uuid
      - $ref: '#/definitions/si_safety_signature_readwrite'

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