Skip to content
Margo v0.0.22

Check report schema

#

This schema describes the complete report produced by margo check --diagnostics json, including findings and summary counts.

Margo check report v1

The JSON envelope emitted by margo check --diagnostics json.

  • diagnosticsarray*

    All findings, including warnings, in source order.

    • *
      • codestring*

        minLength=1

      • columninteger

        minimum=1

      • hintstring
      • lineinteger

        minimum=1

      • messagestring*

        minLength=1

      • pointerstring
      • severitystring

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

      • sourcestring
  • errorsinteger*

    Number of error-severity findings.

    minimum=0

  • policystring

    SHA-256 identity of the trusted host policy when one was supplied.

  • warningsinteger*

    Number of warning-severity findings.

    minimum=0

Used by

  • The margo check JSON output.
  • CI checks that consume compatibility findings deterministically.
  • margo schema check-report, which emits the exact embedded bytes.