← API reference
CANONICAL TYPE REFERENCE

SurfaceDiagnostic

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

codeString!

Stable diagnostic code (e.g. "GQL_VALIDATION", "X_BAD_PATH"). See DiagnosticCode in SurfaceKit for the full catalogue.

severityString!

Severity level: "error", "warning", or "info".

pathString!

definition-rooted path to the problematic location (e.g. "definition.steps[0].fetch.document").

messageString!

Human-readable description of the finding.

hintString

Fix advice from the diagnostic catalogue; null when unavailable.

View exact SDL
"""
A single finding from the two-tier surface-definition validator (Tier-1 SurfaceKit + Tier-2 live-schema GraphQL).
"""
type SurfaceDiagnostic {
  """
  Stable diagnostic code (e.g. "GQL_VALIDATION", "X_BAD_PATH"). See DiagnosticCode in SurfaceKit for the full catalogue.
  """
  code: String!
  """Severity level: "error", "warning", or "info"."""
  severity: String!
  """
  definition-rooted path to the problematic location (e.g. "definition.steps[0].fetch.document").
  """
  path: String!
  """Human-readable description of the finding."""
  message: String!
  """Fix advice from the diagnostic catalogue; null when unavailable."""
  hint: String
}

One stable address across all schema views. Follow a field’s type to explore connections between domains.