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
use std::error::Error as StdError;
use serde::{Deserialize, Serialize};
use crate::{
spec::{
r#ref::{FromRef, Ref, RefError, RefType},
PathItem, Spec,
},
Map,
};
/// Map of possible out-of band callbacks related to the parent operation.
///
/// Each value in the map is a [Path Item Object] that describes a set of requests that may be
/// initiated by the API provider and the expected responses.
///
/// See <https://spec.openapis.org/oas/v3.1.1#callback-object>.
///
/// NB: this structure is flattened when serializing and unflattened when deserializing in order to
/// support spec extensions. I.e., `paths` is a synthetic property within the data tree that
/// comprises an OpenAPI document.
///
/// [Path Item Object]: https://spec.openapis.org/oas/v3.1.1#path-item-object
#[derive(Debug, Clone, Default, PartialEq, Deserialize, Serialize)]
#[serde(try_from = "CallbackSerde", into = "CallbackSerde")]
pub struct Callback {
/// Map of [Path Item Object]s that describe a set of requests that may be initiated by the API
/// provider and the expected responses.
///
/// The key value used to identify the [Path Item Object] is an expression, evaluated at
/// runtime, that identifies a URL to use for the callback operation.
///
/// [Path Item Object]: https://spec.openapis.org/oas/v3.1.1#path-item-object
pub paths: Map<String, PathItem>,
/// Specification extensions.
///
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
///
/// See <https://spec.openapis.org/oas/v3.1.1#specification-extensions>.
pub extensions: Map<String, serde_json::Value>,
}
#[derive(Debug, Deserialize, Serialize)]
#[serde(transparent)]
struct CallbackSerde(serde_json::Map<String, serde_json::Value>);
impl TryFrom<CallbackSerde> for Callback {
type Error = Box<dyn StdError>;
fn try_from(CallbackSerde(map): CallbackSerde) -> Result<Self, Self::Error> {
let (extensions, paths) = bisect_map(map, |key| key.starts_with("x-"));
let paths = paths
.into_iter()
.map(|(key, value)| serde_json::from_value(value).map(|v| (key, v)))
.collect::<Result<_, _>>()?;
Ok(Self {
paths,
extensions: extensions.into_iter().collect(),
})
}
}
fn bisect_map(
map: serde_json::Map<String, serde_json::Value>,
predicate: fn(&String) -> bool,
) -> (
serde_json::Map<String, serde_json::Value>,
serde_json::Map<String, serde_json::Value>,
) {
let mut first = map;
let mut second = first.clone();
first.retain(|key, _| predicate(key));
second.retain(|key, _| !predicate(key));
(first, second)
}
impl From<Callback> for CallbackSerde {
fn from(val: Callback) -> Self {
let Callback { paths, extensions } = val;
CallbackSerde(
paths
.into_iter()
.map(|(key, val)| {
(
key,
serde_json::to_value(val).expect("path item serialization should not fail"),
)
})
.chain(extensions)
.collect(),
)
}
}
impl FromRef for Callback {
fn from_ref(spec: &Spec, path: &str) -> Result<Self, RefError> {
let refpath = path.parse::<Ref>()?;
match refpath.kind {
RefType::Callback => spec
.components
.as_ref()
.and_then(|cs| cs.callbacks.get(&refpath.name))
.ok_or_else(|| RefError::Unresolvable(path.to_owned()))
.and_then(|oor| oor.resolve(spec)),
_ => Err(RefError::MismatchedType(refpath.kind, RefType::Callback)),
}
}
}