Site report schema

This schema describes the report produced by margo site --diagnostics json, including the staged publication result and artifact counts.

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

artifactsinteger*
Number of published artifacts.
minimum=0
manifeststring*
Digest of the exact artifact manifest.
pattern="^[0-9a-f]{64}$"
pagesarray*
Source-to-output page records.
- *
  - actionsobject
    - markdownboolean
    - pdfboolean
    - pdfModestring
      enum=["pre-rendered","client"]
    - printChartDataboolean
  - alternatesarray
    - *
      - localestring*
      - urlstring*
  - authorsarray
  - canonicalstring
  - descriptionstring
  - documentDigeststring
    pattern="^[0-9a-f]{64}$"
  - familystring
  - imageOverflowstring
    enum=["limit","allow"]
  - layoutstring
  - localestring
  - modifiedAtstring
  - outputstring*
    Site-relative generated HTML path.
  - publishedAtstring
  - sourcestring*
    Site-relative Markdown source path.
  - tagsarray
  - titlestring
policystring
Digest of the trusted host policy when one was supplied.
schemaVersionvalue*
const="margo-site-report/v1"

Used by