Class AnalysisRuleResponse

The result of applying a single static analysis rule to the analyzed source code.

Hierarchy

  • AnalysisRuleResponse

Constructors

constructor

Properties

additionalProperties? errors executionError executionTimeMs identifier output violations

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

errors

errors: string[]

A list of error messages encountered while executing the rule.

executionError

executionError: null | string

An error message if the rule execution failed, or null if execution succeeded.

executionTimeMs

executionTimeMs: number

The time taken to execute the rule, in milliseconds.

identifier

identifier: string

The identifier of the rule that produced this response.

output

output: string

The raw output produced by the rule engine during execution.

violations

violations: AnalysisViolation[]

The list of violations found by this rule.

Settings

Member Visibility

Theme

Generated using TypeDoc