Skip to main content

Schemas

Schemas make public artifacts easier to validate and consume. They also reduce ambiguity inside the project: advisory, report, tool, and metadata records should use consistent fields before those records are published at scale.

The current schema files live under /data/schemas/ in the built site. They are intended for validation tooling, external inspection, and future automation.

Available Schemas

  • Advisory schema.
  • Report schema.
  • Tool contract schema.
  • Content frontmatter schema.

Schemas are public contracts for records that may later be consumed by researchers, validators, and external tools. They should remain stable once published, versioned when changed, and narrow enough that downstream users can validate records without depending on internal process notes.

Schema Standard

Schemas should remain conservative. Required fields should capture publication-critical facts such as identifier, status, owner, route, processing model, and review date. Optional fields can evolve as the publication program matures.

Schemas are public contracts for records that may later be consumed by researchers, validators, and external tools. They should remain stable once published, versioned when changed, and narrow enough that downstream users can validate records without depending on internal process notes.

Schema Use

Schemas are public contracts for records that may later be consumed by researchers, validators, and external tools. They should remain stable once published, versioned when changed, and narrow enough that downstream users can validate records without depending on internal process notes.