gatelineAPI reference

Interface ReviewFinding

interface ReviewFinding {
    block: string;
    failureScenario: null | string;
    id: string;
    line: number;
    plausible: boolean;
    requirement: null | string;
    resolution: null | ReviewResolution;
    round: null | number;
    severity: "unknown" | "blocking" | "major" | "minor";
    severityText: string;
    title: string;
    where: null | string;
}

Properties

block failureScenario id line plausible requirement resolution round severity severityText title where

Properties

block

block: string

The whole finding, heading through the end of its body, verbatim.

failureScenario

failureScenario: null | string

id

id: string

'F1'

line

line: number

1-based line of the heading.

plausible

plausible: boolean

True when the reviewer marked the finding PLAUSIBLE rather than proven.

requirement

requirement: null | string

resolution

resolution: null | ReviewResolution

The latest disposition from a later round, or null.

round

round: null | number

The round that raised it, or null when the report numbers no rounds.

severity

severity: "unknown" | "blocking" | "major" | "minor"

severityText

severityText: string

The severity cell verbatim, e.g. 'minor (PLAUSIBLE)'.

title

title: string

where

where: null | string

Contract fields, verbatim and without their bold label. Null when absent.

Settings

Member Visibility

On This Page

Properties