json-schema-diff 0.1.8

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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use std::collections::BTreeMap;

use schemars::schema::{RootSchema, Schema, SchemaObject};

pub struct Resolver {
    ref_lookup: BTreeMap<String, String>,
}

impl Resolver {
    pub fn for_schema(root: &RootSchema) -> Self {
        let mut ref_lookup = BTreeMap::new();

        for (key, schema) in &root.definitions {
            if let Some(id) = schema.get_schema_id() {
                ref_lookup.insert(id.to_owned(), key.clone());
            }

            if let Some(root_id) = root.schema.get_schema_id() {
                ref_lookup.insert(format!("{root_id}#/definitions/{key}"), key.clone());
                ref_lookup.insert(format!("{root_id}#/$defs/{key}"), key.clone());
            }

            ref_lookup.insert(format!("#/definitions/{key}"), key.clone());
            ref_lookup.insert(format!("#/$defs/{key}"), key.clone());
        }

        Self { ref_lookup }
    }

    /// Resolves a reference.
    ///
    /// `root` must be the same schema that was used to construct the resolver.
    /// This is not checked.
    pub fn resolve<'a>(&self, root: &'a RootSchema, reference: &str) -> Option<&'a Schema> {
        let key = self.ref_lookup.get(reference)?;
        root.definitions.get(key)
    }
}

trait MayHaveSchemaId {
    fn get_schema_id(&self) -> Option<&str>;
}

impl MayHaveSchemaId for SchemaObject {
    fn get_schema_id(&self) -> Option<&str> {
        self.metadata
            .as_ref()
            .and_then(|m| m.id.as_ref())
            .map(|id| id.as_str())
    }
}

impl MayHaveSchemaId for Schema {
    fn get_schema_id(&self) -> Option<&str> {
        match self {
            Schema::Object(schema_obj) => schema_obj.get_schema_id(),
            Schema::Bool(_) => None,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn draft7_definitions() {
        let root: RootSchema = serde_json::from_str(
            r#"{
                "definitions": {
                    "A": {}
                }
            }"#,
        )
        .unwrap();
        let resolver = Resolver::for_schema(&root);

        let resolved = resolver.resolve(&root, "#/definitions/A");
        assert!(resolved.is_some());

        let resolved = resolver.resolve(&root, "#/definitions/not-there");
        assert!(resolved.is_none());
    }

    #[test]
    fn draft7_root_has_id() {
        let root: RootSchema = serde_json::from_str(
            r#"{
                "$id": "urn:uuid:e773a2e8-d746-4dc6-9480-0bba5ff33504",
                "definitions": {
                    "A": {}
                }
            }"#,
        )
        .unwrap();
        let resolver = Resolver::for_schema(&root);

        let resolved = resolver.resolve(&root, "#/definitions/A");
        assert!(resolved.is_some());
        let resolved = resolver.resolve(
            &root,
            "urn:uuid:e773a2e8-d746-4dc6-9480-0bba5ff33504#/definitions/A",
        );
        assert!(resolved.is_some());
    }

    #[test]
    fn draft7_definition_has_id() {
        let root: RootSchema = serde_json::from_str(
            r#"{
                "definitions": {
                    "A": {
                        "$id": "some-id"
                    }
                }
            }"#,
        )
        .unwrap();
        let resolver = Resolver::for_schema(&root);

        let resolved = resolver.resolve(&root, "some-id");
        assert!(resolved.is_some());
        assert_eq!(resolved, resolver.resolve(&root, "#/definitions/A"))
    }

    #[test]
    fn draft2020_12_defs() {
        let root: RootSchema = serde_json::from_str(
            r#"{
                "$defs": {
                    "A": {
                        "$id": "some-id"
                    }
                }
            }"#,
        )
        .unwrap();
        let resolver = Resolver::for_schema(&root);

        let resolved = resolver.resolve(&root, "#/$defs/A");
        assert!(resolved.is_some());
        assert_eq!(resolved, resolver.resolve(&root, "some-id"));

        let resolved = resolver.resolve(&root, "#/$defs/not-there");
        assert!(resolved.is_none());
    }
}