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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
use super::*;
use sppparse::{SparsePointer, SparseValue};
use std::collections::HashSet;
#[derive(
Debug, PartialEq, Serialize, Deserialize, Clone, Getters, Sparsable, OApiCheck, OApiExt,
)]
#[getset(get = "pub")]
#[serde(rename_all = "camelCase")]
#[oapi(handler = "self._oapi_check")]
pub struct OApiDocument {
openapi: Version,
info: OApiInfo,
#[serde(default)]
servers: Option<Vec<OApiServer>>,
#[serde(default)]
paths: HashMap<String, OApiPathItem>,
#[serde(default)]
components: Option<OApiComponents>,
#[serde(default)]
security: HashMap<String, SparseSelector<OApiSecurityScheme>>,
#[serde(default)]
tags: Option<Vec<OApiTag>>,
#[serde(default)]
external_docs: Option<OApiExternalDocumentation>,
#[serde(flatten)]
#[getset(get)]
_extension: HashMap<String, Value>,
}
impl OApiDocument {
fn check_semver(&self) -> Result<(), OApiError> {
let version_req: VersionReq = VersionReq::parse("^3.0.0").unwrap();
if !version_req.matches(&self.openapi) {
return Err(OApiError::OApiCheck(
"/openapi".to_string(),
"Only OpenApi ^3 is supported".to_string(),
));
}
Ok(())
}
fn check_path_parameter_dup(
bread_crumb: &mut Vec<String>,
parameters: &[SparseSelector<OApiParameter>],
) -> Result<(), OApiError> {
let mut uniq: HashSet<(&String, &OApiParameterLocation)> = HashSet::new();
let mut tmp_store: Vec<SparseValue<'_, OApiParameter>> = Vec::new();
for param in parameters.iter() {
tmp_store.push(param.get()?);
}
for param in tmp_store.iter() {
if !uniq.insert((param.name(), param.in_())) {
return Err(OApiError::OApiCheck(
crate::check::connect_bread_crumbs(bread_crumb),
format!("Parameters should be unique by name and location. Param `{}` in `{:#?}` is duplicated", param.name(), param.in_()),
));
}
}
Ok(())
}
fn check_path_parameters_inner(
bread_crumb: &mut Vec<String>,
path: &str,
parameters: Vec<&SparseSelector<OApiParameter>>,
) -> Result<(), OApiError> {
for param in parameters.into_iter() {
let param = param.get()?;
if let OApiParameterLocation::Path = param.in_() {
if !path.contains(format!("{{{}}}", param.name()).as_str()) {
bread_crumb.push(path.to_string());
return Err(OApiError::OApiCheck(
crate::check::connect_bread_crumbs(bread_crumb),
format!("Parameter `{{{}}}` is not present in path", param.name()),
));
}
if let Some(required) = param.required() {
if !*required {
bread_crumb.push(path.to_string());
return Err(OApiError::OApiCheck(
crate::check::connect_bread_crumbs(bread_crumb),
format!(
"Parameter `{{{}}}` requirement is mandatory, because it's in path",
param.name()
),
));
}
}
}
}
Ok(())
}
fn check_path_parameters(&self, bread_crumb: &mut Vec<String>) -> Result<(), OApiError> {
for (path, op) in self.paths().iter() {
let mut params: Vec<&SparseSelector<OApiParameter>> = Vec::new();
Self::check_path_parameter_dup(bread_crumb, op.parameters().as_slice())?;
params.extend(op.parameters().iter());
if let Some(x) = op.get() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
if let Some(x) = op.head() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
if let Some(x) = op.options() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
if let Some(x) = op.post() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
if let Some(x) = op.put() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
if let Some(x) = op.patch() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
if let Some(x) = op.delete() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
if let Some(x) = op.trace() {
Self::check_path_parameter_dup(bread_crumb, x.parameters())?;
params.extend(x.parameters().iter());
}
Self::check_path_parameters_inner(bread_crumb, path, params)?;
}
Ok(())
}
fn check_opid<'a, 'b>(
resp: &'b mut Vec<bool>,
uniq: &mut HashSet<&'a String>,
op: Option<&'a OApiOperation>,
) {
if let Some(x) = op {
if let Some(x) = x.operation_id() {
if !uniq.insert(x) {
resp.push(uniq.insert(x));
}
}
}
}
pub fn get_operation_id(&self, opid_searched: &str) -> Option<&OApiOperation> {
let mut opid: Vec<Option<&OApiOperation>> = Vec::with_capacity(8);
for op in self.paths().values() {
opid.push(op.get().as_ref());
opid.push(op.head().as_ref());
opid.push(op.post().as_ref());
opid.push(op.put().as_ref());
opid.push(op.patch().as_ref());
opid.push(op.delete().as_ref());
opid.push(op.options().as_ref());
opid.push(op.trace().as_ref());
for op in opid.drain(..) {
if let Some(op) = op {
if let Some(opid) = op.operation_id() {
if opid == opid_searched {
return Some(op);
}
}
}
}
}
None
}
fn _oapi_check(
&self,
_root: &SparseRoot<OApiDocument>,
bread_crumb: &mut Vec<String>,
) -> Result<(), OApiError> {
self.check_semver()?;
let mut uniq: HashSet<&String> = HashSet::new();
bread_crumb.push("path".to_string());
for op in self.paths.values() {
let mut resp: Vec<bool> = Vec::with_capacity(8);
Self::check_opid(&mut resp, &mut uniq, op.get().as_ref());
Self::check_opid(&mut resp, &mut uniq, op.delete().as_ref());
Self::check_opid(&mut resp, &mut uniq, op.put().as_ref());
Self::check_opid(&mut resp, &mut uniq, op.patch().as_ref());
Self::check_opid(&mut resp, &mut uniq, op.head().as_ref());
Self::check_opid(&mut resp, &mut uniq, op.post().as_ref());
Self::check_opid(&mut resp, &mut uniq, op.options().as_ref());
Self::check_opid(&mut resp, &mut uniq, op.trace().as_ref());
if !resp.into_iter().all(|a| a) {
return Err(OApiError::OApiCheck(
crate::check::connect_bread_crumbs(bread_crumb),
"OperationId should be unique amongst all the paths".to_string(),
));
}
}
self.check_path_parameters(bread_crumb)?;
bread_crumb.pop();
Ok(())
}
}