swagger: '2.0'
info:
  description: Configuration for Reference object to pass for relaxing a WAF Learning engine learnt rule resource.
  version: 'v2'
  title: ns_waf_relaxation
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: ns_waf_relaxation
    description: Reference object to pass for relaxing a WAF Learning engine learnt rule
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/ns_waf_relaxation:
    get:
      tags:
        - ns_waf_relaxation
      summary: GET all ns_waf_relaxation
      operationId: getall_ns_waf_relaxation
      description: Use this object to deploy or skip a WAF Learning engine rule
      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 ns_waf_relaxation 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 ns_waf_relaxation 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 ns_waf_relaxation resources.
          enum:
            - yes
      responses:
        200:
          description:  for ns_waf_relaxation
          schema: 
              $ref: '#/definitions/getns_waf_relaxationsResponse'
        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:
  getns_waf_relaxationResponse:
    type: object
    required:
      - ns_waf_relaxation
    properties:
      ns_waf_relaxation:
        $ref: '#/definitions/ns_waf_relaxation'
    title: getns_waf_relaxationResponse
    example:
      ns_waf_relaxation:
        field_type: "string_value"
        status: "true"
        mode: "1"
        violation_location: "integer_value"
        violation_id: "integer_value"
        field_name: "string_value"
        resourceid: "string_value"
        max_value: "integer_value"
        value_type: "string_value"
        http_req_url: "string_value"
        value_expr: "string_value"
        si_device_ip_address: "string_value"
        min_value: "integer_value"
        comment: "comments"
        profile_name: "string_value"
        adm_learn_profile_name: "string_value"

  getns_waf_relaxationsResponse:
    type: object
    required:
      - ns_waf_relaxation
    properties:
      ns_waf_relaxation:
        type: array
        items:
          $ref: '#/definitions/ns_waf_relaxation'
    title: getns_waf_relaxationsResponse
    example:
      ns_waf_relaxation:
        field_type: "string_value"
        status: "true"
        mode: "1"
        violation_location: "integer_value"
        violation_id: "integer_value"
        field_name: "string_value"
        resourceid: "string_value"
        max_value: "integer_value"
        value_type: "string_value"
        http_req_url: "string_value"
        value_expr: "string_value"
        si_device_ip_address: "string_value"
        min_value: "integer_value"
        comment: "comments"
        profile_name: "string_value"
        adm_learn_profile_name: "string_value"

  ns_waf_relaxation_readwrite:
    type: object
    properties:
      field_type:
        description: "Field type to be relaxed"
        type: string
        format: string
        maxLength: 512
      status:
        description: "Status is true when the rule is enabled and false when the rule is disabled"
        type: boolean
        format: boolean
      mode:
        description: "mode to be deployed as open/closed"
        type: integer
        format: int32
      violation_location:
        description: "Violation Location"
        type: integer
        format: int32
      violation_id:
        description: "Violation Category"
        type: integer
        format: int32
      field_name:
        description: "Field name to be relaxed"
        type: string
        format: string
        maxLength: 512
      resourceid:
        description: "Resourceid generated for each relaxation rule."
        type: string
        format: string
        maxLength: 128
      max_value:
        description: "Maximum length of the filed to be relaxed"
        type: integer
        format: int32
      value_type:
        description: "Value type to be relaxed"
        type: string
        format: string
        maxLength: 512
      http_req_url:
        description: "HTTP Request URL to be relaxed"
        type: string
        format: string
        maxLength: 2000
      value_expr:
        description: "Value expression to be relaxed"
        type: string
        format: string
        maxLength: 512
      si_device_ip_address:
        description: "NetScaler IP Address"
        type: string
        format: string
        minLength: 1
        maxLength: 64
      min_value:
        description: "minimum length of the field to be relaxed"
        type: integer
        format: int32
      comment:
        description: "Comment to be sent as payload in relaxation rule nitro"
        type: string
        format: string
        maxLength: 255
      profile_name:
        description: "profile_name"
        type: string
        format: string
        minLength: 1
        maxLength: 32
      adm_learn_profile_name:
        description: "adm_learn_profile_name"
        type: string
        format: string
        minLength: 1
        maxLength: 32

  ns_waf_relaxation:
    allOf:
      - $ref: '#/definitions/ns_waf_relaxation_readwrite'

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