JSON Schema Diff

Sobre esta ferramenta

This is not the JSON Diff tool: that one compares two documents by value. This compares two schemas by what they would accept, so every change also says whether it is breaking, meaning a document that satisfied the old schema could now fail the new one. A property added to the schema is not breaking on its own, since existing data simply does not have it yet; a property removed is breaking only when the new schema also sets additionalProperties to false, since only then does carrying that property become a rejection. A field becoming required is breaking, since existing data may not have it; a field no longer required is not. A type narrowing, like a change from number to integer, is breaking; a type widening, like integer to number, is not, and that one subtype relationship is the only one this tool knows among the JSON Schema primitive types. An enum value removed is breaking, since data using it now fails; a value added is not. A tightened bound, a lower maximum or a higher minimum, is breaking; a loosened one is not. A pattern change is always treated as breaking, since comparing two regular expressions for which accepts more is not attempted, and treating an unknown effect as safe would be the wrong default. The subset covered is deliberately the one the site's own Schema Generator writes and the Schema Validator applies: schema-valued additionalProperties, tuple-form items, combinators and $ref are not walked into.

Como usar

1. 1 Paste the old schema into the left pane and the new one into the right, or load the sample.
2. 2 Press Compare.
3. 3 Read the breaking changes first: the summary line counts them separately, and the filter chips isolate just those rows.