schemars 1.2.1

Generate JSON Schemas from Rust code
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

#![allow(clippy::approx_constant)]

use crate::prelude::*;
use pretty_assertions::assert_eq;

static THREE: f64 = 3.0;

#[allow(dead_code)]
#[derive(JsonSchema)]
#[schemars(extend("obj" = {"array": [null, ()]}))]
#[schemars(extend("3" = THREE), extend("pi" = THREE + 0.14))]
struct Struct {
    #[schemars(extend("foo" = "bar"))]
    value: Value,
    #[schemars(extend("type" = ["number", "string"]))]
    int: i32,
}

#[test]
fn extend_struct() {
    test!(Struct).assert_snapshot().custom(|schema, _| {
        assert_eq!(schema.get("obj"), Some(&json!({ "array": [null, null] })));
        assert_eq!(schema.get("3"), Some(&json!(3.0)));
        assert_eq!(schema.get("pi"), Some(&json!(3.14)));
        assert_eq!(
            schema.as_value().pointer("/properties/value"),
            Some(&json!({ "foo": "bar" }))
        );
        assert_eq!(
            schema.as_value().pointer("/properties/int/type"),
            Some(&json!(["number", "string"]))
        );
    });
}

#[allow(dead_code)]
#[derive(JsonSchema)]
#[schemars(extend("obj" = {"array": [null, ()]}))]
#[schemars(extend("3" = THREE), extend("pi" = THREE + 0.14))]
struct TupleStruct(
    #[schemars(extend("foo" = "bar"))] Value,
    #[schemars(extend("type" = ["number", "string"]))] usize,
);

#[test]
fn extend_tuple_struct() {
    test!(TupleStruct).assert_snapshot().custom(|schema, _| {
        assert_eq!(schema.get("obj"), Some(&json!({ "array": [null, null] })));
        assert_eq!(schema.get("3"), Some(&json!(3.0)));
        assert_eq!(schema.get("pi"), Some(&json!(3.14)));
        assert_eq!(
            schema.as_value().pointer("/prefixItems/0"),
            Some(&json!({ "foo": "bar" }))
        );
        assert_eq!(
            schema.as_value().pointer("/prefixItems/1/type"),
            Some(&json!(["number", "string"]))
        );
    });
}

#[allow(dead_code)]
#[derive(JsonSchema)]
#[schemars(extend("foo" = "bar"))]
enum ExternalEnum {
    #[schemars(extend("foo" = "bar"))]
    Unit,
    #[schemars(extend("foo" = "bar"))]
    NewType(Value),
    #[schemars(extend("foo" = "bar"))]
    Tuple(i32, bool),
    #[schemars(extend("foo" = "bar"))]
    Struct { i: i32, b: bool },
}

#[test]
fn extend_externally_tagged_enum() {
    test!(ExternalEnum).assert_snapshot().custom(|schema, _| {
        assert_eq!(schema.get("foo"), Some(&json!("bar")));

        for i in 0..4 {
            assert_eq!(
                schema.as_value().pointer(&format!("/oneOf/{i}/foo")),
                Some(&json!("bar"))
            );
        }
    });
}

#[allow(dead_code)]
#[derive(JsonSchema)]
#[schemars(tag = "t", extend("foo" = "bar"))]
enum InternalEnum {
    #[schemars(extend("foo" = "bar"))]
    Unit,
    #[schemars(extend("foo" = "bar"))]
    NewType(Value),
    #[schemars(extend("foo" = "bar"))]
    Struct { i: i32, b: bool },
}

#[test]
fn extend_internally_tagged_enum() {
    test!(InternalEnum).assert_snapshot().custom(|schema, _| {
        assert_eq!(schema.get("foo"), Some(&json!("bar")));

        for i in 0..3 {
            assert_eq!(
                schema.as_value().pointer(&format!("/oneOf/{i}/foo")),
                Some(&json!("bar"))
            );
        }
    });
}

#[allow(dead_code)]
#[derive(JsonSchema)]
#[schemars(tag = "t", content = "c", extend("foo" = "bar"))]
enum AdjacentEnum {
    #[schemars(extend("foo" = "bar"))]
    Unit,
    #[schemars(extend("foo" = "bar"))]
    NewType(Value),
    #[schemars(extend("foo" = "bar"))]
    Tuple(i32, bool),
    #[schemars(extend("foo" = "bar"))]
    Struct { i: i32, b: bool },
}

#[test]
fn extend_adjacently_tagged_enum() {
    test!(AdjacentEnum).assert_snapshot().custom(|schema, _| {
        assert_eq!(schema.get("foo"), Some(&json!("bar")));

        for i in 0..4 {
            assert_eq!(
                schema.as_value().pointer(&format!("/oneOf/{i}/foo")),
                Some(&json!("bar"))
            );
        }
    });
}

#[allow(dead_code)]
#[derive(JsonSchema)]
#[schemars(untagged, extend("foo" = "bar"))]
enum UntaggedEnum {
    #[schemars(extend("foo" = "bar"))]
    Unit,
    #[schemars(extend("foo" = "bar"))]
    NewType(Value),
    #[schemars(extend("foo" = "bar"))]
    Tuple(i32, bool),
    #[schemars(extend("foo" = "bar"))]
    Struct { i: i32, b: bool },
}

#[test]
fn extend_untagged_enum() {
    test!(UntaggedEnum).assert_snapshot().custom(|schema, _| {
        assert_eq!(schema.get("foo"), Some(&json!("bar")));

        for i in 0..4 {
            assert_eq!(
                schema.as_value().pointer(&format!("/anyOf/{i}/foo")),
                Some(&json!("bar"))
            );
        }
    });
}