swagger: '2.0'
info:
  description: Configuration for WAF AsLearn threshold and grace period configuration per ADC per profile per security check will be stored resource.
  version: 'v2'
  title: si_as_learn_config
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: si_as_learn_config
    description: WAF AsLearn threshold and grace period configuration per ADC per profile per security check will be stored
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 CwcAuth 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_as_learn_config:
    get:
      tags:
        - si_as_learn_config
      summary: GET all si_as_learn_config
      operationId: getall_si_as_learn_config
      description: WAF Learning engine config 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 CwcAuth 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 si_as_learn_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 si_as_learn_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 si_as_learn_config resources.
          enum:
            - yes
      responses:
        200:
          description:  for si_as_learn_config
          schema: 
              $ref: '#/definitions/getsi_as_learn_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'

definitions:
  getsi_as_learn_configResponse:
    type: object
    required:
      - si_as_learn_config
    properties:
      si_as_learn_config:
        $ref: '#/definitions/si_as_learn_config'
    title: getsi_as_learn_configResponse
    example:
      si_as_learn_config:
        threshold: "80"
        si_device_ip_address: "string_value"
        grace_period: "integer_value"
        ctnsappname: "NA"
        rpt_sample_time: "1580922196"
        violation_id: "integer_value"
        profile_name: "Citrix_Workspace_SN"

  getsi_as_learn_configsResponse:
    type: object
    required:
      - si_as_learn_config
    properties:
      si_as_learn_config:
        type: array
        items:
          $ref: '#/definitions/si_as_learn_config'
    title: getsi_as_learn_configsResponse
    example:
      si_as_learn_config:
        threshold: "80"
        si_device_ip_address: "string_value"
        grace_period: "integer_value"
        ctnsappname: "NA"
        rpt_sample_time: "1580922196"
        violation_id: "integer_value"
        profile_name: "Citrix_Workspace_SN"

  si_as_learn_config_readwrite:
    type: object
    properties:
      threshold:
        description: "WAF learning engine threshold count"
        type: integer
        format: int32
      si_device_ip_address:
        description: "Field to store the IP Address of the ADC who's config is stored"
        type: string
        format: string
        maxLength: 512
      grace_period:
        description: "WAF Learning engine time before a rule is auto deployed"
        type: integer
        format: int32
      ctnsappname:
        description: "ctnsappname the primary key for config"
        type: string
        format: string
        maxLength: 255
      rpt_sample_time:
        description: "Report sample time"
        type: integer
        format: int32
      violation_id:
        description: "ID to map the WAF Security Check"
        type: integer
        format: int32
      profile_name:
        description: "Field to store the WAF profile name"
        type: string
        format: string
        maxLength: 255

  si_as_learn_config:
    allOf:
      - $ref: '#/definitions/si_as_learn_config_readwrite'

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