Skip to content

Verification

Generated from public report-related SDK types. Rule details are split into Verification rules and JSON contracts into Report outputs.

ExportKindSourceSummary
Findinginterfacesdk/ts/src/ops.tsSingle verification finding, optionally tied to a resolved segment index.
Reportinterfacesdk/ts/src/ops.tsVerification result containing all findings emitted by enabled rules.
Severitytypesdk/ts/src/ops.tsSeverity level for a verification finding.
ToolpathMetainterfacesdk/ts/src/ops.tsOptional provenance and invariant metadata attached to a resolved toolpath.

Finding

ts
export interface Finding

Single verification finding, optionally tied to a resolved segment index.

Verify rendered preview
Sample: VerifyCheck a resolved design against machine-safety contracts and inspect findings.typescript: docs/site/examples/verify.ts · python: docs/site/examples/verify.py

Fields

FieldTypeRequiredSummary
rulestringYesStable rule identifier, such as bounds or peak-acceleration.
severitySeverityYesWhether the finding blocks the contract or is advisory.
segmentnumber | nullYesZero-based segment index, or null when the finding is global.
messagestringYesHuman-readable finding details.

Report

ts
export interface Report

Verification result containing all findings emitted by enabled rules.

Verify rendered preview
Sample: VerifyCheck a resolved design against machine-safety contracts and inspect findings.typescript: docs/site/examples/verify.ts · python: docs/site/examples/verify.py

Fields

FieldTypeRequiredSummary
findingsFinding[]YesDeclared in the public API.

Severity

ts
export type Severity = 'error' | 'warning'

Severity level for a verification finding.

Verify rendered preview
Sample: VerifyCheck a resolved design against machine-safety contracts and inspect findings.typescript: docs/site/examples/verify.ts · python: docs/site/examples/verify.py

ToolpathMeta

ts
export interface ToolpathMeta

Optional provenance and invariant metadata attached to a resolved toolpath.

Fields

FieldTypeRequiredSummary
generatorstringNoName of the generator or pipeline that produced the toolpath.
unitsstringNoCoordinate and unit convention, normally millimeters.
source_hashstringNoStable source hash when the toolpath was derived from an external artifact.
invariantsstring[]NoHuman-readable invariants the toolpath is expected to satisfy.
  • docs/11-profiles-and-reports.md
  • docs/16-support-matrix.md