Valid JSON Is Only Half the Output Contract

Описание и применение

Валидация структуры Markdown и JSON обеспечивает корректный обмен данными между командами.

Задача

A response can be valid JSON yet still fail to meet downstream consumer expectations due to missing or misordered sections.

Результат

The validator identifies structural and schema violations, allowing teams to fix handoffs before downstream consumption.

Рабочий процесс

• Define the consumer requirement with a contract file (JSON Schema + Markdown rules).
• Create a handoff document (Markdown + JSON).
• Run output_contracts validate against the contract and handoff files.
• Inspect the validation report for missing sections, ordering issues, or forbidden phrases.
• Correct the handoff based on the report and re‑validate.

Доказательства

Validation exits with status 1 because the fixture violates the contract.

Источник

A clean validation returns 0.

Источник

The JSON example requires an identifier, a constrained status, an integer count, and a non-empty items array.

Источник