Skip to content
Margo v0.0.22

Schemas

Diagnostic schema

#

This schema describes one stable diagnostic object: its code, severity, location, message, and remediation hint.

Copy page

Margo diagnostic output v1

One structured diagnostic emitted by a Margo command failure or compatibility report.

  • codestring*

    Stable machine-readable diagnostic code.

    minLength=1

  • columninteger

    One-based source column.

    minimum=1

  • hintstring

    Actionable remediation hint.

  • lineinteger

    One-based source line.

    minimum=1

  • messagestring*

    Human-readable diagnostic message.

    minLength=1

  • pointerstring

    JSON Pointer identifying the affected field.

  • severitystring

    Diagnostic severity when present.

    enum=["info","warning","error"]

  • sourcestring

    Source path associated with the diagnostic.

Used by

  • JSON command failures and compatibility findings.
  • The margo check and margo doctor reports.
  • margo schema diagnostic, which emits the exact embedded bytes.