domains / families / software-engineering / json-schema-manual

json-schema-manual

authentic

JSON Schema Manual: draft 2020-12 validation schema from a confirmed field list, with required and enum values only where confirmed. Use for an API or import contract.

When to use

• I need a JSON Schema
• validate this payload before it goes in
• make an API contract for this table
• document the shape of this import file
• generate a form from this schema
• turn the agreed fields into a schema

When not to use

• It validates structure. It does not check a value against a database, confirm that a
• A schema is only as good as the field list behind it, and it cannot repair a list that
• Formats such as `date` and `email` are annotations: many validators treat them as
• No versioning, no publication, no registry, and no CI wiring. That is the consuming
• Cross-field rules - a due date after an invoice date, a total equal to a sum - are not
• Nothing is verified until the user validates a real payload against it.

Skill page

Source