Skip to content

SurfaceDiagnostic ​

Type: Object

A single finding from the two-tier surface-definition validator (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL).

Fields ​

NameTypeArgsDescriptionDeprecated
codeString!Stable diagnostic code (e.g. "GQL_VALIDATION", "X_BAD_PATH"). See DiagnosticCode in SurfaceKit for the full catalogue.
hintStringFix advice from the diagnostic catalogue; null when unavailable.
messageString!Human-readable description of the finding.
pathString!definition-rooted path to the problematic location (e.g. "definition.steps[0].fetch.document").
severityString!Severity level: "error", "warning", or "info".

Connect machines, automate workflows, and build custom apps for print production.