swagger: '2.0'
info:
  description: Configuration for Native Violations Details resource.
  version: 'v2'
  title: native_violation
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: native_violation
    description: Native Violations Details
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/native_violation:
    get:
      tags:
        - native_violation
      summary: GET all native_violation
      operationId: getall_native_violation
      description: Provides details of native violations.
      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: feature
          type: string
          required: false
          description: Use this query-parameter to specify the feature
          enum:
            - bot
            - waf
            - network
            - bot,waf
            - bot,waf,network
        - 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: type
          type: string
          required: false
          description: Use this query-parameter to specify the type of report
          enum:
            - detail
            - timeseries_by_name
            - timeseries
            - summary
            - summary_by_severity
            - summary_by_category
            - summary_by_name
            - top_apps
            - indicator_mapping
            - summary_ml
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the native_violation 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 native_violation 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 native_violation resources.
          enum:
            - yes
      responses:
        200:
          description:  for native_violation
          schema: 
              $ref: '#/definitions/getnative_violationsResponse'
        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:
  getnative_violationResponse:
    type: object
    required:
      - native_violation
    properties:
      native_violation:
        $ref: '#/definitions/native_violation'
    title: getnative_violationResponse
    example:
      native_violation:
        ind_weight_desc: "TestMappedDescription"
        severity_desc: "High"
        ind_detection_time: "1630557173"
        ind_value: "0"
        appname: "appname"
        svcname: "svc_1"
        ctnsappname: "appname_1"
        ip_address: "10.102.103.113"
        severity: "1"
        violation_ratio: "0.11"
        ind_name_desc: "TestIndicatorName"
        ind_detection_msg: "Detection Message"
        ind_recommend_desc: "TestIndDescription"
        rpt_sample_time: "1630557173"
        violation_count: "100"
        ind_category_desc: "TestIndicatorRecommendation"
        ind_id: "2001"
        total_violations: "1000"
        confidence: "90"

  getnative_violationsResponse:
    type: object
    required:
      - native_violation
    properties:
      native_violation:
        type: array
        items:
          $ref: '#/definitions/native_violation'
    title: getnative_violationsResponse
    example:
      native_violation:
        ind_weight_desc: "TestMappedDescription"
        severity_desc: "High"
        ind_detection_time: "1630557173"
        ind_value: "0"
        appname: "appname"
        svcname: "svc_1"
        ctnsappname: "appname_1"
        ip_address: "10.102.103.113"
        severity: "1"
        violation_ratio: "0.11"
        ind_name_desc: "TestIndicatorName"
        ind_detection_msg: "Detection Message"
        ind_recommend_desc: "TestIndDescription"
        rpt_sample_time: "1630557173"
        violation_count: "100"
        ind_category_desc: "TestIndicatorRecommendation"
        ind_id: "2001"
        total_violations: "1000"
        confidence: "90"

  native_violation_readwrite:
    type: object
    properties:
      ind_weight_desc:
        description: "Indicator Weight description"
        type: string
        format: string
      severity_desc:
        description: "Severity description"
        type: string
        format: string
      ind_detection_time:
        description: "Detection Time"
        type: number
        format: int64
      ind_value:
        description: "Indicator value"
        type: integer
        format: int32
      appname:
        description: "Application Name"
        type: string
        format: string
      svcname:
        description: "Service Name"
        type: string
        format: string
      ctnsappname:
        description: "VServer Name"
        type: string
        format: string
      ip_address:
        description: "IP Address"
        type: string
        format: string
      severity:
        description: "Severity."
        type: integer
        format: int32
      violation_ratio:
        description: "Violation Ratio"
        type: string
        format: string
      ind_name_desc:
        description: "Indicator name description"
        type: string
        format: string
      ind_detection_msg:
        description: "Indicator Detection Message"
        type: string
        format: string
      ind_recommend_desc:
        description: "Indicator Recommendation"
        type: string
        format: string
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: int64
      violation_count:
        description: "Violation Count"
        type: integer
        format: int32
      ind_category_desc:
        description: "Indicator category description"
        type: string
        format: string
      ind_id:
        description: "Indicator Id"
        type: number
        format: int64
      total_violations:
        description: "Total Violation"
        type: integer
        format: int32
      confidence:
        description: "Confidence"
        type: integer
        format: int32

  native_violation:
    allOf:
      - $ref: '#/definitions/native_violation_readwrite'

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