openapi-schema-to-json-schema 0.1.0

Convert OpenAPI 3.0 schema objects to JSON Schema draft-04
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

//! String format handling.

mod common;

use common::{assert_schema, assert_schema_default, DRAFT4};
use openapi_schema_to_json_schema::Options;
use serde_json::json;

#[test]
fn plain_string_is_untouched() {
    assert_schema_default(
        json!({ "type": "string" }),
        json!({ "$schema": DRAFT4, "type": "string" }),
    );
}

#[test]
fn handles_date() {
    assert_schema_default(
        json!({ "type": "string", "format": "date" }),
        json!({ "$schema": DRAFT4, "type": "string", "format": "date" }),
    );

    let options = Options {
        date_to_date_time: Some(true),
        ..Options::new()
    };
    assert_schema(
        json!({ "type": "string", "format": "date" }),
        &options,
        json!({ "$schema": DRAFT4, "type": "string", "format": "date-time" }),
    );
}

#[test]
fn handles_byte_format() {
    assert_schema_default(
        json!({ "type": "string", "format": "byte" }),
        json!({
            "$schema": DRAFT4,
            "type": "string",
            "format": "byte",
            "pattern": "^[\\w\\d+\\/=]*$"
        }),
    );
}

#[test]
fn retaining_custom_formats() {
    assert_schema_default(
        json!({ "type": "string", "format": "custom_email" }),
        json!({ "$schema": DRAFT4, "type": "string", "format": "custom_email" }),
    );
}

#[test]
fn retain_password_format() {
    assert_schema_default(
        json!({ "type": "string", "format": "password" }),
        json!({ "$schema": DRAFT4, "type": "string", "format": "password" }),
    );
}

#[test]
fn retain_binary_format() {
    assert_schema_default(
        json!({ "type": "string", "format": "binary" }),
        json!({ "$schema": DRAFT4, "type": "string", "format": "binary" }),
    );
}

#[test]
fn date_time_passes_through() {
    // date-time is a valid draft-04 format. It is left alone even without
    // date_to_date_time.
    assert_schema_default(
        json!({ "type": "string", "format": "date-time" }),
        json!({ "$schema": DRAFT4, "type": "string", "format": "date-time" }),
    );
}

#[test]
fn byte_pattern_applies_regardless_of_type() {
    // The byte pattern is driven by format alone, with no type guard.
    assert_schema_default(
        json!({ "format": "byte" }),
        json!({ "$schema": DRAFT4, "format": "byte", "pattern": "^[\\w\\d+\\/=]*$" }),
    );
}

#[test]
fn valid_draft04_formats_pass_through() {
    // These formats are already valid in draft-04. Each is returned with format
    // unchanged and no minimum, maximum, or pattern added.
    for fmt in ["email", "hostname", "ipv4", "ipv6", "uri", "uri-reference"] {
        assert_schema_default(
            json!({ "type": "string", "format": fmt }),
            json!({ "$schema": DRAFT4, "type": "string", "format": fmt }),
        );
    }
}