Interface Rule

The analysis rule that caused the alert.

interface Rule {
    additionalProperties?: { [key: string]: any };
    description?: string;
    friendlyName?: string;
    helpMessage?: string;
    opaqueId?: string;
    resources?: string;
    tags?: string[];
}

Properties

additionalProperties? description? friendlyName? helpMessage? opaqueId? resources? tags?

Properties

OptionaladditionalProperties

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

Additional properties of this rule dependent on the rule type. For example, dependency rules may include the CVE ID if it is available.

Optionaldescription

description?: string

Description of what this rule detects

OptionalfriendlyName

friendlyName?: string

Plain-text rule identifier

OptionalhelpMessage

helpMessage?: string

Additional information about this rule

OptionalopaqueId

opaqueId?: string

Tool-specific rule identifier

Optionalresources

resources?: string

Markdown-formatted list of resources to learn more about the Rule. In some cases, RuleInfo.AdditionalProperties.advisoryUrls is used instead.

Optionaltags

tags?: string[]

Classification tags for this rule

Settings

Member Visibility

On This Page

Properties