json-schema-diff 0.1.2

Diff changes between JSON schema files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

# 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, such as:

* `required`
* `patternProperties` (entirely ignored)
* `const` (changes from `{"const": "foo"}` to `{"type": "string"}` are not detected)

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

```bash
cargo run --features=build-binary -- \
    schema-old.json \
    schema-new.json
```

## Usage as library

```rust
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: SimpleJsonSchemaType::String }
        },
        Change {
            path: "".to_owned(),
            change: ChangeKind::TypeAdd { added: SimpleJsonSchemaType::Boolean }
        }
    ]
);
```

## License

Licensed under Apache 2.0, see `./LICENSE`