oas3 0.2.1

Structures and tools to parse, navigate and validate OpenAPI v3 specifications.
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
171
172
173
174
175
176
177

use serde_json::Value as JsonValue;

use super::{Error, Validate};
use crate::{path::Path, spec::SchemaType, Spec};

#[derive(Debug, Clone)]
pub struct DataType {
    r#type: SchemaType,
    nullable: bool,
}

impl DataType {
    pub fn new(type_: SchemaType) -> Self {
        Self {
            r#type: type_,
            nullable: false,
        }
    }

    pub fn boolean() -> Self {
        Self::new(SchemaType::Boolean)
    }
    pub fn integer() -> Self {
        Self::new(SchemaType::Integer)
    }
    pub fn number() -> Self {
        Self::new(SchemaType::Number)
    }
    pub fn string() -> Self {
        Self::new(SchemaType::String)
    }
    pub fn array() -> Self {
        Self::new(SchemaType::Array)
    }
    pub fn object() -> Self {
        Self::new(SchemaType::Object)
    }

    pub fn set_nullable(self, nullable: bool) -> Self {
        Self { nullable, ..self }
    }

    pub fn nullable(self) -> Self {
        Self {
            nullable: true,
            ..self
        }
    }
}

impl Validate for DataType {
    /// Checks that the value provided is of expected type.
    fn validate(&self, val: &JsonValue, path: Path) -> Result<(), Error> {
        if self.nullable && val.is_null() {
            return Ok(());
        }

        let data_type = match val {
            JsonValue::Bool(_) => SchemaType::Boolean,
            JsonValue::Number(num) => {
                if num.is_i64() {
                    SchemaType::Integer
                } else {
                    SchemaType::Number
                }
            }
            JsonValue::String(_) => SchemaType::String,
            JsonValue::Array(_) => SchemaType::Array,
            JsonValue::Object(_) => SchemaType::Object,

            // already checked and returned
            JsonValue::Null => return Err(Error::InvalidNull(path)),
        };

        // check type equality
        if self.r#type != data_type {
            // integers also count as numbers
            if val.is_i64() && self.r#type == SchemaType::Number {
                return Ok(());
            }

            return Err(Error::TypeMismatch(path, self.r#type));
        }

        Ok(())
    }
}

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

    #[test]
    fn bool_validation() {
        let v = DataType::boolean();

        valid_vs_invalid!(
            v,
            &[&TRUE],
            &[&NULL, &INTEGER, &STRING, &ARRAY_INTS, &OBJ_EMPTY],
        );
    }

    #[test]
    fn integer_validation() {
        let v = DataType::integer();

        valid_vs_invalid!(
            v,
            &[&INTEGER],
            &[&FLOAT, &NULL, &TRUE, &STRING, &ARRAY_INTS, &OBJ_EMPTY],
        );
    }

    #[test]
    fn number_validation() {
        let v = DataType::number();

        valid_vs_invalid!(
            v,
            &[&INTEGER, &FLOAT],
            &[&NULL, &TRUE, &STRING, &ARRAY_INTS, &OBJ_EMPTY],
        );
    }

    #[test]
    fn string_validation() {
        let v = DataType::string();

        valid_vs_invalid!(
            v,
            &[&STRING],
            &[&NULL, &TRUE, &INTEGER, &FLOAT, &ARRAY_INTS, &OBJ_EMPTY],
        );
    }

    #[test]
    fn nullable_validation() {
        let v = DataType::boolean().nullable();

        valid_vs_invalid!(
            v,
            &[&TRUE, &NULL],
            &[&FLOAT, &STRING, &ARRAY_INTS, &OBJ_EMPTY],
        );

        let v = DataType::string().nullable();

        valid_vs_invalid!(
            v,
            &[&STRING, &NULL],
            &[&FLOAT, &TRUE, &ARRAY_INTS, &OBJ_EMPTY],
        );
    }

    #[test]
    fn array_validation() {
        let v = DataType::array();

        valid_vs_invalid!(
            v,
            &[&ARRAY_INTS, &ARRAY_STRS],
            &[&TRUE, &NULL, &FLOAT, &STRING, &OBJ_EMPTY],
        );
    }

    #[test]
    fn object_validation() {
        let v = DataType::object();

        valid_vs_invalid!(
            v,
            &[&OBJ_NUMS, &OBJ_EMPTY, &OBJ_MIXED, &OBJ_MIXED2],
            &[&NULL, &INTEGER, &FLOAT, &STRING, &ARRAY_INTS],
        );
    }
}