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

use bytes::Bytes;
use http::HeaderMap;

use super::{OperationSpec, ParamReplacement, TestAuthentication, TestOperation, TestParam};

#[derive(Debug, Clone)]
pub enum RequestSource {
    Example { media_type: String, name: String },
    Raw(Bytes),
    Empty,
}

#[derive(Debug, Clone)]
pub struct RequestSpec {
    pub source: RequestSource,
    pub bad: bool,
    pub auth: Option<TestAuthentication>,
    pub params: Vec<ParamReplacement>,
    pub content_type_override: Option<String>,
}

impl RequestSpec {
    pub fn empty() -> Self {
        Self {
            source: RequestSource::Empty,
            bad: false,
            auth: None,
            params: vec![],
            content_type_override: None,
        }
    }

    pub fn from_example<M, N>(media_type: M, name: N) -> Self
    where
        M: Into<String>,
        N: Into<String>,
    {
        Self {
            source: RequestSource::Example {
                media_type: media_type.into(),
                name: name.into(),
            },
            ..Self::empty()
        }
    }

    pub fn from_json_example<N>(name: N) -> Self
    where
        N: Into<String>,
    {
        Self {
            source: RequestSource::Example {
                media_type: "application/json".to_owned(),
                name: name.into(),
            },
            ..Self::empty()
        }
    }

    pub fn from_bad_raw<T>(body: T) -> Self
    where
        T: Into<Bytes>,
    {
        Self {
            source: RequestSource::Raw(body.into()),
            bad: true,
            ..Self::empty()
        }
    }

    pub fn override_content_type<T>(self, ct: T) -> Self
    where
        T: Into<String>,
    {
        Self {
            content_type_override: Some(ct.into()),
            ..self
        }
    }

    pub fn with_auth(self, auth: &TestAuthentication) -> Self {
        Self {
            auth: Some(auth.clone()),
            ..self
        }
    }

    pub fn no_auth(self) -> Self {
        Self { auth: None, ..self }
    }

    pub fn add_param<N, V>(mut self, name: N, val: V) -> Self
    where
        N: Into<String>,
        V: Into<String>,
    {
        let param = ParamReplacement::new(name, val);
        self.params.push(param);
        self
    }
}

#[derive(Debug, Clone)]
pub struct TestRequest {
    pub operation: TestOperation,
    pub headers: HeaderMap,
    pub params: Vec<TestParam>,
    pub body: Bytes,
}