8 releases

0.1.7 Jun 6, 2023
0.1.6 May 16, 2023
0.1.4 Apr 7, 2023
0.1.2 Mar 29, 2023

#341 in Database interfaces

Download history 1142/week @ 2024-03-14 1262/week @ 2024-03-21 1509/week @ 2024-03-28 1235/week @ 2024-04-04 2306/week @ 2024-04-11 1901/week @ 2024-04-18 1699/week @ 2024-04-25 1588/week @ 2024-05-02 661/week @ 2024-05-09 502/week @ 2024-05-16 230/week @ 2024-05-23 279/week @ 2024-05-30 476/week @ 2024-06-06 240/week @ 2024-06-13 480/week @ 2024-06-20 187/week @ 2024-06-27

1,411 downloads per month
Used in 2 crates

Apache-2.0

40KB
881 lines

json-schema-diff

A work-in-progress tool to diff changes between JSON schemas. A lot of JSON schema features are not implemented and therefore ignored, see the issue tracker.

Use this tool as a best-effort to find obviously breaking changes in CI, but not for much more.

This crate is used with draft-07 but even that is work in progress.

Usage via CLI

Install Rust and:

cargo install json-schema-diff

cat schema-old.json schema-new.json
# {"type": "string"}
# {"type": "boolean"}

cargo run --features=build-binary -- \
    schema-old.json \
    schema-new.json
# {"path":"","change":{"TypeRemove":{"removed":"string"}},"is_breaking":true}
# {"path":"","change":{"TypeAdd":{"added":"boolean"}},"is_breaking":false}

Sentry uses this tool in sentry-kafka-schemas to annotate pull requests with breaking changes made to schema definitions. It invokes the CLI tool on the schema from master vs the schema in the PR, and post-processes the output using a Python script for human consumption.

is_breaking is just a suggestion. You may choose to ignore it entirely and instead define which kinds of changes are breaking to you in wrapper scripts.

Usage as library

use json_schema_diff::*;

let lhs = serde_json::json! {{ 
    "type": "string",
}};
let rhs = serde_json::json! {{ 
    "type": "boolean",
}};

assert_eq!(
    json_schema_diff::diff(lhs, rhs).unwrap(),
    vec![
        Change {
            path: "".to_owned(),
            change: ChangeKind::TypeRemove { removed: JsonSchemaType::String }
        },
        Change {
            path: "".to_owned(),
            change: ChangeKind::TypeAdd { added: JsonSchemaType::Boolean }
        }
    ]
);

License

Licensed under Apache 2.0

Dependencies

~1.9–3MB
~59K SLoC