Interface FindingInit

The fields a Finding is constructed from.

interface FindingInit {
    message: string;
    path?: string | null;
    rule: string;
    tool?: string | null;
}

Properties

message: string

Explains the problem for a person; not part of the contract.

path?: string | null

JSON pointer to where the problem is, where that applies.

rule: string

Stable snake_case identifier of the rule that fired.

tool?: string | null

The descriptor the finding concerns; null for a bare schema check.