openapiv3-resolve 0.2.0

Reference resolution helpers for the openapiv3 crate.
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

use super::resolver::{Resolvable, Resolver};
use super::{ResolvedHeader, ResolvedSchema, Shared};
use crate::ResolveError;
use indexmap::IndexMap;
use openapiv3::{Encoding, Example, Link, MediaType, QueryStyle, RequestBody, Response};

/// [`RequestBody`] with every `$ref` replaced by the item it named.
#[derive(Debug, PartialEq)]
pub struct ResolvedRequestBody {
    /// See [`RequestBody::description`].
    pub description: Option<String>,
    /// See [`RequestBody::content`].
    pub content: IndexMap<String, ResolvedMediaType>,
    /// See [`RequestBody::required`].
    pub required: bool,
    /// See [`RequestBody::extensions`].
    pub extensions: IndexMap<String, serde_json::Value>,
}

/// [`Response`] with every `$ref` replaced by the item it named.
#[derive(Debug, PartialEq)]
pub struct ResolvedResponse {
    /// See [`Response::description`].
    pub description: String,
    /// See [`Response::headers`].
    pub headers: IndexMap<String, Shared<ResolvedHeader>>,
    /// See [`Response::content`].
    pub content: IndexMap<String, ResolvedMediaType>,
    /// See [`Response::links`].
    pub links: IndexMap<String, Shared<Link>>,
    /// See [`Response::extensions`].
    pub extensions: IndexMap<String, serde_json::Value>,
}

/// [`MediaType`] with every `$ref` replaced by the item it named.
#[derive(Debug, PartialEq)]
pub struct ResolvedMediaType {
    /// See [`MediaType::schema`].
    pub schema: Option<Shared<ResolvedSchema>>,
    /// See [`MediaType::example`].
    pub example: Option<serde_json::Value>,
    /// See [`MediaType::examples`].
    pub examples: IndexMap<String, Shared<Example>>,
    /// See [`MediaType::encoding`].
    pub encoding: IndexMap<String, ResolvedEncoding>,
    /// See [`MediaType::extensions`].
    pub extensions: IndexMap<String, serde_json::Value>,
}

/// [`Encoding`] with every `$ref` replaced by the item it named.
#[derive(Debug, PartialEq)]
pub struct ResolvedEncoding {
    /// See [`Encoding::content_type`].
    pub content_type: Option<String>,
    /// See [`Encoding::headers`].
    pub headers: IndexMap<String, Shared<ResolvedHeader>>,
    /// See [`Encoding::style`].
    pub style: Option<QueryStyle>,
    /// See [`Encoding::explode`].
    pub explode: bool,
    /// See [`Encoding::allow_reserved`].
    pub allow_reserved: bool,
    /// See [`Encoding::extensions`].
    pub extensions: IndexMap<String, serde_json::Value>,
}

impl Resolvable for RequestBody {
    type Resolved = ResolvedRequestBody;

    fn resolve_inline(&self, cx: &mut Resolver<'_>) -> Result<Self::Resolved, ResolveError> {
        Ok(ResolvedRequestBody {
            description: self.description.clone(),
            content: super::resolve_map(&self.content, cx)?,
            required: self.required,
            extensions: self.extensions.clone(),
        })
    }
}

impl Resolvable for Response {
    type Resolved = ResolvedResponse;

    fn resolve_inline(&self, cx: &mut Resolver<'_>) -> Result<Self::Resolved, ResolveError> {
        Ok(ResolvedResponse {
            description: self.description.clone(),
            headers: cx.ref_or_map(&self.headers)?,
            content: super::resolve_map(&self.content, cx)?,
            links: cx.ref_or_map(&self.links)?,
            extensions: self.extensions.clone(),
        })
    }
}

impl Resolvable for MediaType {
    type Resolved = ResolvedMediaType;

    fn resolve_inline(&self, cx: &mut Resolver<'_>) -> Result<Self::Resolved, ResolveError> {
        Ok(ResolvedMediaType {
            schema: self
                .schema
                .as_ref()
                .map(|schema| cx.ref_or(schema))
                .transpose()?,
            example: self.example.clone(),
            examples: cx.ref_or_map(&self.examples)?,
            encoding: super::resolve_map(&self.encoding, cx)?,
            extensions: self.extensions.clone(),
        })
    }
}

impl Resolvable for Encoding {
    type Resolved = ResolvedEncoding;

    fn resolve_inline(&self, cx: &mut Resolver<'_>) -> Result<Self::Resolved, ResolveError> {
        Ok(ResolvedEncoding {
            content_type: self.content_type.clone(),
            headers: cx.ref_or_map(&self.headers)?,
            style: self.style.clone(),
            explode: self.explode,
            allow_reserved: self.allow_reserved,
            extensions: self.extensions.clone(),
        })
    }
}