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
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

//! from_parameter branch logic.

mod common;

use common::DRAFT4;
use openapi_schema_to_json_schema::{from_parameter, Error, Options};
use serde_json::json;

#[test]
fn minimal_parameter() {
    let param = json!({
        "name": "parameter name",
        "in": "cookie",
        "schema": { "type": "string", "nullable": true }
    });
    let result = from_parameter(param, &Options::new()).unwrap();
    assert_eq!(
        result,
        json!({ "$schema": DRAFT4, "type": ["string", "null"] })
    );
}

#[test]
fn extensive_parameter() {
    let param = json!({
        "name": "parameter name",
        "in": "cookie",
        "schema": { "type": "string", "nullable": true },
        "required": true,
        "allowEmptyValue": true,
        "deprecated": true,
        "allowReserved": true,
        "style": "matrix",
        "explode": true,
        "example": "parameter example"
    });
    let result = from_parameter(param, &Options::new()).unwrap();
    assert_eq!(
        result,
        json!({ "$schema": DRAFT4, "type": ["string", "null"] })
    );
}

#[test]
fn parameter_with_mime_schemas() {
    let param = json!({
        "name": "parameter name",
        "in": "cookie",
        "content": {
            "application/javascript": { "schema": { "type": "string", "nullable": true } },
            "text/css": { "schema": { "type": "string", "nullable": true } }
        }
    });
    let result = from_parameter(param, &Options::new()).unwrap();
    assert_eq!(
        result,
        json!({
            "application/javascript": { "$schema": DRAFT4, "type": ["string", "null"] },
            "text/css": { "$schema": DRAFT4, "type": ["string", "null"] }
        })
    );
}

#[test]
fn parameter_with_mimes_without_a_schema() {
    let param = json!({
        "name": "parameter name",
        "in": "cookie",
        "content": {
            "application/javascript": { "schema": { "type": "string", "nullable": true } },
            "text/css": {}
        }
    });
    let result = from_parameter(param, &Options::new()).unwrap();
    assert_eq!(
        result,
        json!({
            "application/javascript": { "$schema": DRAFT4, "type": ["string", "null"] },
            "text/css": { "$schema": DRAFT4 }
        })
    );
}

#[test]
fn using_parameter_description() {
    let param = json!({
        "name": "parameter name",
        "in": "cookie",
        "description": "parameter description",
        "schema": { "description": "schema description" }
    });
    let result = from_parameter(param, &Options::new()).unwrap();
    assert_eq!(
        result,
        json!({ "$schema": DRAFT4, "description": "parameter description" })
    );
}

#[test]
fn throwing_on_parameters_without_schemas() {
    let param = json!({ "name": "parameter name", "in": "cookie" });
    let err = from_parameter(param, &Options::new()).unwrap_err();
    assert!(err.to_string().contains("parameter must have either a"));
    assert!(matches!(err, Error::InvalidInput(_)));
}

#[test]
fn schema_wins_over_content() {
    // A truthy schema is checked first, so content is ignored and the result is
    // a single schema, not a MIME map.
    let param = json!({
        "schema": { "type": "integer" },
        "content": { "application/json": { "schema": { "type": "string" } } }
    });
    let result = from_parameter(param, &Options::new()).unwrap();
    assert_eq!(result, json!({ "type": "integer", "$schema": DRAFT4 }));
}

#[test]
fn content_branch_copies_description() {
    // A truthy description is copied onto each per-MIME schema. The outer map
    // carries no $schema.
    let param = json!({
        "description": "d",
        "content": { "application/json": { "schema": { "type": "string" } } }
    });
    let result = from_parameter(param, &Options::new()).unwrap();
    assert_eq!(
        result,
        json!({
            "application/json": { "type": "string", "$schema": DRAFT4, "description": "d" }
        })
    );
}

#[test]
fn lenient_parameter_without_schema() {
    let param = json!({ "name": "parameter name", "in": "cookie" });
    let options = Options {
        strict_mode: Some(false),
        ..Options::new()
    };
    let result = from_parameter(param, &options).unwrap();
    assert_eq!(result, json!({ "$schema": DRAFT4 }));
}