Findings

Finding

Finding = object

Represents a https://docs.caido.io/reference/features/logging/findings|Finding.

Properties

description?

optional description: string

The description of the finding.

host

host: string

The host of the request attached to this finding

id

id: ID

The ID of the finding.

path

path: string

The path of the request attached to this finding

reporter

reporter: string

The reporter of the finding.

title

title: string

The title of the finding.

---

FindingsPageContext

FindingsPageContext = object

Findings page context.

Properties

kind

kind: "Findings"

selection

selection: Selection<ID>

---

FindingsSDK

FindingsSDK = object

Utilities to interact with findings

Properties

addRequestEditorExtension()

addRequestEditorExtension: (extension: Extension) => void

Add an extension to the request editor.

Parameters

Parameter	Type	Description
extension	Extension	The extension to add.

Returns

void

addRequestViewMode()

addRequestViewMode: (options: RequestViewModeOptions) => void

Add a custom request view mode.

Parameters

Parameter	Type	Description
options	RequestViewModeOptions	The view mode options.

Returns

void

addResponseViewMode()

addResponseViewMode: (options: ResponseViewModeOptions) => void

Add a custom response view mode.

Parameters

Parameter	Type	Description
options	ResponseViewModeOptions	The view mode options.

Returns

void

createFinding()

createFinding: (requestId: ID, options: object) => Promise<Finding | undefined>

Create a Finding.

Parameters

Parameter	Type	Description
requestId	ID	The id of the request the finding is associated with.
options	{ dedupeKey?: string; description?: string; reporter: string; title: string; }	Options for the finding.
options.dedupeKey?	string	If a finding with the same deduplication key already exists, it will not create a new finding.
options.description?	string	The description of the finding.
options.reporter	string	The reporter of the finding.
options.title	string	The title of the finding.

Returns

Promise<Finding | undefined>

The created finding.