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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
//! Operation Object
use crate::common::helpers::{Context, PushError, ValidateWithContext, validate_required_string};
use crate::common::reference::RefOr;
use crate::v2::external_documentation::ExternalDocumentation;
use crate::v2::parameter::Parameter;
use crate::v2::response::Responses;
use crate::v2::spec::{Scheme, Spec};
use crate::v2::tag::Tag;
use crate::validation::Options;
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct Operation {
/// A list of tags for API documentation control.
/// Tags can be used for logical grouping of operations by resources or any other qualifier.
#[serde(skip_serializing_if = "Option::is_none")]
pub tags: Option<Vec<String>>,
/// A short summary which by default SHOULD override that of the referenced component.
/// If the referenced object-type does not allow a summary field, then this field has no effect.
#[serde(skip_serializing_if = "Option::is_none")]
pub summary: Option<String>,
/// A description which by default SHOULD override that of the referenced component.
/// CommonMark syntax MAY be used for rich text representation.
/// If the referenced object-type does not allow a description field, then this field has no effect.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
/// Additional external documentation for this operation.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "externalDocs")]
pub external_docs: Option<ExternalDocumentation>,
/// Unique string used to identify the operation.
/// The id MUST be unique among all operations described in the API.
/// Tools and libraries MAY use the operationId to uniquely identify an operation, therefore,
/// it is recommended to follow common programming naming conventions.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "operationId")]
pub operation_id: Option<String>,
/// A list of MIME types the operation can consume.
/// This overrides the consumes definition at the Swagger Object.
/// An empty value MAY be used to clear the global definition.
#[serde(skip_serializing_if = "Option::is_none")]
pub consumes: Option<Vec<String>>,
/// A list of MIME types the operation can produce.
/// This overrides the produces definition at the Swagger Object.
/// An empty value MAY be used to clear the global definition.
#[serde(skip_serializing_if = "Option::is_none")]
pub produces: Option<Vec<String>>,
/// A list of parameters that are applicable for this operation.
/// If a parameter is already defined at the Path Item, the new definition will override it,
/// but can never remove it.
/// The list MUST NOT include duplicated parameters.
/// A unique parameter is defined by a combination of a name and location.
/// The list can use the Reference Object to link to parameters that are defined at the Swagger Object's parameters.
/// There can be one "body" parameter at most.
#[serde(skip_serializing_if = "Option::is_none")]
pub parameters: Option<Vec<RefOr<Parameter>>>,
/// **Required** The list of possible responses as they are returned from executing this operation.
pub responses: Responses,
/// The transfer protocol for the operation.
/// Values MUST be from the list: "http", "https", "ws", "wss".
/// The value overrides the Swagger Object schemes definition.
#[serde(skip_serializing_if = "Option::is_none")]
pub schemes: Option<Vec<Scheme>>,
/// Declares this operation to be deprecated.
/// Usage of the declared operation should be refrained.
/// Default value is false.
#[serde(skip_serializing_if = "Option::is_none")]
pub deprecated: Option<bool>,
/// A declaration of which security schemes are applied for this operation.
/// The list of values describes alternative security schemes that can be used
/// (that is, there is a logical OR between the security requirements).
/// This definition overrides any declared top-level security.
/// To remove a top-level security declaration, an empty array can be used.
#[serde(skip_serializing_if = "Option::is_none")]
pub security: Option<Vec<BTreeMap<String, Vec<String>>>>,
/// Allows extensions to the Swagger Schema.
/// The field name MUST begin with `x-`, for example, `x-internal-id`.
/// The value can be null, a primitive, an array or an object.
#[serde(flatten)]
#[serde(with = "crate::common::extensions")]
#[serde(skip_serializing_if = "Option::is_none")]
pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}
impl ValidateWithContext<Spec> for Operation {
fn validate_with_context(&self, ctx: &mut Context<Spec>, path: String) {
if let Some(operation_id) = &self.operation_id
&& !ctx
.visited
.insert(format!("#/paths/operations/{operation_id}"))
{
ctx.error(
path.clone(),
format_args!("operationId `{operation_id}` already exists"),
);
}
if let Some(tags) = &self.tags {
for (i, tag) in tags.iter().enumerate() {
validate_required_string(tag, ctx, format!("{path}.tags[{i}]"));
if tag.is_empty() {
continue;
}
let reference = format!("#/tags/{tag}");
if let Ok(spec_tag) = RefOr::<Tag>::new_ref(reference.clone()).get_item(ctx.spec) {
if ctx.visit(reference.clone()) {
spec_tag.validate_with_context(ctx, reference);
}
} else if !ctx.is_option(Options::IgnoreMissingTags) {
ctx.error(
path.clone(),
format_args!(".tags[{i}]: `{tag}` not found in spec"),
);
}
}
}
if let Some(parameters) = &self.parameters {
let mut body_count = 0;
for (i, parameter) in parameters.clone().iter().enumerate() {
parameter.validate_with_context(ctx, format!("{path}.parameters[{i}]"));
if let RefOr::Item(Parameter::Body(_)) = parameter {
body_count += 1;
}
}
if body_count > 1 {
ctx.error(
path.clone(),
format_args!(
".parameters: only one body parameter allowed, found {body_count}",
),
);
}
}
self.responses
.validate_with_context(ctx, format!("{path}.responses"));
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::v2::parameter::{InPath, StringParameter};
use crate::v2::response::Response;
#[test]
fn deserialize() {
assert_eq!(
serde_json::from_value::<Operation>(serde_json::json!({
"tags": [
"pet"
],
"summary": "Updates a pet in the store with form data",
"description": "Update Pet with Form",
"externalDocs": {
"description": "find more info here",
"url": "https://swagger.io/about"
},
"operationId": "updatePetWithForm",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet that needs to be updated",
"required": true,
"type": "string"
},
{
"$ref": "#/definitions/Pet",
},
],
"responses": {
"200": {
"description": "Pet updated."
},
"405": {
"$ref": "#/responses/InvalidInput"
},
"x-extra": "extra",
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
],
"deprecated": true,
"schemes": [
"https"
],
"x-extra": "extra",
}))
.unwrap(),
Operation {
tags: Some(vec!["pet".to_owned()]),
summary: Some("Updates a pet in the store with form data".to_owned()),
description: Some("Update Pet with Form".to_owned()),
external_docs: Some(ExternalDocumentation {
description: Some("find more info here".to_owned()),
url: "https://swagger.io/about".to_owned(),
..Default::default()
}),
operation_id: Some("updatePetWithForm".to_owned()),
consumes: Some(vec!["application/x-www-form-urlencoded".to_owned()]),
produces: Some(vec![
"application/json".to_owned(),
"application/xml".to_owned(),
]),
parameters: Some(vec![
RefOr::new_item(Parameter::Path(Box::new(InPath::String(StringParameter {
name: "petId".to_owned(),
description: Some("ID of pet that needs to be updated".to_owned()),
required: Some(true),
..Default::default()
})))),
RefOr::new_ref("#/definitions/Pet".to_owned()),
]),
responses: Responses {
responses: Some({
let mut map = BTreeMap::new();
map.insert(
"200".to_owned(),
RefOr::new_item(Response {
description: "Pet updated.".to_owned(),
..Default::default()
}),
);
map.insert(
"405".to_owned(),
RefOr::new_ref("#/responses/InvalidInput".to_owned()),
);
map
}),
extensions: Some({
let mut map = BTreeMap::new();
map.insert("x-extra".to_owned(), serde_json::json!("extra"));
map
}),
..Default::default()
},
security: Some(vec![{
let mut map = BTreeMap::new();
map.insert(
"petstore_auth".to_owned(),
vec!["write:pets".to_owned(), "read:pets".to_owned()],
);
map
}]),
deprecated: Some(true),
schemes: Some(vec![Scheme::HTTPS]),
extensions: Some({
let mut map = BTreeMap::new();
map.insert("x-extra".to_owned(), serde_json::json!("extra"));
map
}),
},
"deserialization"
);
}
#[test]
fn serialize() {
assert_eq!(
serde_json::to_value(Operation {
tags: Some(vec!["pet".to_owned()]),
summary: Some("Updates a pet in the store with form data".to_owned()),
description: Some("Update Pet with Form".to_owned()),
external_docs: Some(ExternalDocumentation {
description: Some("find more info here".to_owned()),
url: "https://swagger.io/about".to_owned(),
..Default::default()
}),
operation_id: Some("updatePetWithForm".to_owned()),
consumes: Some(vec!["application/x-www-form-urlencoded".to_owned()]),
produces: Some(vec![
"application/json".to_owned(),
"application/xml".to_owned(),
]),
parameters: Some(vec![
RefOr::new_item(Parameter::Path(Box::new(InPath::String(StringParameter {
name: "petId".to_owned(),
description: Some("ID of pet that needs to be updated".to_owned()),
required: Some(true),
..Default::default()
})))),
RefOr::new_ref("#/definitions/Pet".to_owned()),
]),
responses: Responses {
responses: Some({
let mut map = BTreeMap::new();
map.insert(
"200".to_owned(),
RefOr::new_item(Response {
description: "Pet updated.".to_owned(),
..Default::default()
}),
);
map.insert(
"405".to_owned(),
RefOr::new_ref("#/responses/InvalidInput".to_owned()),
);
map
}),
extensions: Some({
let mut map = BTreeMap::new();
map.insert("x-extra".to_owned(), serde_json::json!("extra"));
map
}),
..Default::default()
},
security: Some(vec![{
let mut map = BTreeMap::new();
map.insert(
"petstore_auth".to_owned(),
vec!["write:pets".to_owned(), "read:pets".to_owned()],
);
map
}]),
deprecated: Some(true),
schemes: Some(vec![Scheme::HTTPS]),
extensions: Some({
let mut map = BTreeMap::new();
map.insert("x-extra".to_owned(), serde_json::json!("extra"));
map
}),
})
.unwrap(),
serde_json::json!({
"tags": [
"pet"
],
"summary": "Updates a pet in the store with form data",
"description": "Update Pet with Form",
"externalDocs": {
"description": "find more info here",
"url": "https://swagger.io/about"
},
"operationId": "updatePetWithForm",
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml"
],
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet that needs to be updated",
"required": true,
"type": "string"
},
{
"$ref": "#/definitions/Pet",
},
],
"responses": {
"200": {
"description": "Pet updated."
},
"405": {
"$ref": "#/responses/InvalidInput"
},
"x-extra": "extra",
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
],
"deprecated": true,
"schemes": [
"https"
],
"x-extra": "extra",
}),
"serialization"
);
}
}