ui/server/src/reviewApi · Developer Docs

REST surface for Review mode.

Cockpit server, next. Source: ui/server/src/reviewApi.mjs.

Variables#

MAX_HEADS#

const MAX_HEADS: 100 = 100

Defined in: ui/server/src/reviewApi.mjs:15

Functions#

createReviewRouter()#

createReviewRouter(deps): any

Defined in: ui/server/src/reviewApi.mjs:57

Parameters#

deps

clientOrigin?

string = null

getRoot

() => { ok: true; root: string; } | { error: string; ok: false; }

jobs

{ cancel: Function; enqueue: Function; get: Function; }

jobs.cancel

Function

jobs.enqueue

Function

jobs.get

Function

Returns#

any

slimReport()#

slimReport(result): object

Defined in: ui/server/src/reviewApi.mjs:36

The compact, list-sized view of a finished report (the badges).

Parameters#

result

any

Returns#

object

counts

counts: any = r.counts

degraded

degraded: object

degraded.message

message: any = r.degraded.message

degraded.truncated

truncated: boolean = !!r.degraded.truncated

features

features: any = r.change.features

files

files: any = r.change.counts.files

findings

findings: any = r.findings.length

indicators

indicators: any

scope

scope: object

scope.declared

declared: any = scope.evidence.declared.features.length

scope.touched

touched: any = scope.evidence.touched.features.length

summary

summary: any = r.summary