thearchivist.fun
Research resource ยท Reference resource

JSON Schema: make an import contract explicit

JSON Schema describes the structure and constraints of JSON data. The official overview explains the relationship between a schema, a data instance and a validator. It is useful for portable archive packs, where contributors need a clear agreement about fields, types and allowed values before importing material. Begin with a few real records and identify the minimum useful contract. Specify stable identifiers, required text fields, lists and bounded values where appropriate. Include a version indicator so future changes can be handled deliberately. Validate examples that should succeed and examples that should fail, then write friendly explanations for the most common mistakes. Structural validity does not establish that a historical date is correct, a source is reliable or a URL is safe to render. Those require additional checks and editorial judgment. Different schema versions and validators may support different features, so state which dialect you use. Keep the contract understandable for contributors rather than making every incidental implementation detail a permanent requirement.

Context and provenance

A declarative way to describe the structure and constraints of JSON data.

Sources and evidence

  1. JSON Schema: make an import contract explicit โ€” official resource

Editorial review: 2026-09-23. New evidence may change this account.

Report a problem with this record