schemaui 0.7.2

A Rust library for generating TUI and Web UIs from JSON Schemas for configuration management.
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

use crate::schema::resolver::SchemaResolver;
use schemars::schema::RootSchema;
use serde_json::json;

#[test]
fn resolves_definition_reference() {
    let raw = json!({
        "definitions": {
            "duration": {
                "type": "object",
                "properties": {
                    "value": {"type": "integer"}
                }
            }
        },
        "type": "object",
        "properties": {
            "timeout": {"$ref": "#/definitions/duration"}
        }
    });
    let root: RootSchema = serde_json::from_value(raw.clone()).expect("valid root schema");
    let resolver = SchemaResolver::new(&raw, &root);
    let timeout_schema = root
        .schema
        .object
        .as_ref()
        .unwrap()
        .properties
        .get("timeout")
        .unwrap();
    let resolved = resolver
        .resolve_schema(timeout_schema)
        .expect("resolution succeeds");
    assert!(resolved.object.is_some());
    assert!(
        resolved
            .object
            .as_ref()
            .unwrap()
            .properties
            .contains_key("value")
    );
}

#[test]
fn resolves_pointer_reference() {
    let raw = json!({
        "type": "object",
        "properties": {
            "base": {
                "type": "object",
                "properties": {
                    "url": {"type": "string"}
                }
            },
            "clone": {"$ref": "#/properties/base"}
        }
    });
    let root: RootSchema = serde_json::from_value(raw.clone()).expect("valid root schema");
    let resolver = SchemaResolver::new(&raw, &root);
    let clone_schema = root
        .schema
        .object
        .as_ref()
        .unwrap()
        .properties
        .get("clone")
        .unwrap();
    let resolved = resolver
        .resolve_schema(clone_schema)
        .expect("resolution succeeds");
    let object = resolved.object.expect("object schema");
    assert!(object.properties.contains_key("url"));
}

#[test]
fn preserves_instance_metadata_and_extensions_when_resolving_reference() {
    let raw = json!({
        "definitions": {
            "duration": {
                "title": "Definition Title",
                "description": "Definition description",
                "type": "integer"
            }
        },
        "type": "object",
        "properties": {
            "timeout": {
                "$ref": "#/definitions/duration",
                "title": "Request Timeout",
                "description": "Per-request timeout",
                "default": 5,
                "x-group": "advanced",
                "x-group-title": "Advanced Settings"
            }
        }
    });
    let root: RootSchema = serde_json::from_value(raw.clone()).expect("valid root schema");
    let resolver = SchemaResolver::new(&raw, &root);
    let timeout_schema = root
        .schema
        .object
        .as_ref()
        .unwrap()
        .properties
        .get("timeout")
        .unwrap();
    let resolved = resolver
        .resolve_schema(timeout_schema)
        .expect("resolution succeeds");

    let metadata = resolved.metadata.expect("metadata preserved");
    assert_eq!(metadata.title.as_deref(), Some("Request Timeout"));
    assert_eq!(metadata.description.as_deref(), Some("Per-request timeout"));
    assert_eq!(metadata.default, Some(json!(5)));
    assert_eq!(
        resolved
            .extensions
            .get("x-group")
            .and_then(serde_json::Value::as_str),
        Some("advanced")
    );
    assert_eq!(
        resolved.instance_type,
        root.definitions["duration"]
            .clone()
            .into_object()
            .instance_type
    );
}

#[test]
fn preserves_instance_metadata_for_pointer_references() {
    let raw = json!({
        "type": "object",
        "properties": {
            "base": {
                "title": "Base URL",
                "type": "string"
            },
            "clone": {
                "$ref": "#/properties/base",
                "title": "Service URL",
                "description": "Instance-specific description"
            }
        }
    });
    let root: RootSchema = serde_json::from_value(raw.clone()).expect("valid root schema");
    let resolver = SchemaResolver::new(&raw, &root);
    let clone_schema = root
        .schema
        .object
        .as_ref()
        .unwrap()
        .properties
        .get("clone")
        .unwrap();
    let resolved = resolver
        .resolve_schema(clone_schema)
        .expect("resolution succeeds");

    let metadata = resolved.metadata.expect("metadata preserved");
    assert_eq!(metadata.title.as_deref(), Some("Service URL"));
    assert_eq!(
        metadata.description.as_deref(),
        Some("Instance-specific description")
    );
}