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
//! Operation Object
use crate::common::helpers::{Context, PushError, ValidateWithContext, validate_required_string};
use crate::common::reference::RefOr;
use crate::v3_0::callback::Callback;
use crate::v3_0::external_documentation::ExternalDocumentation;
use crate::v3_0::parameter::Parameter;
use crate::v3_0::request_body::RequestBody;
use crate::v3_0::response::Responses;
use crate::v3_0::security_scheme::SecurityScheme;
use crate::v3_0::server::Server;
use crate::v3_0::spec::Spec;
use crate::v3_0::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 verbose explanation of the operation behavior.
/// [CommonMark](https://spec.commonmark.org) syntax MAY be used for rich text representation.
#[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 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>>>,
/// The request body applicable for this operation.
/// The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification
/// [RFC7231](https://www.rfc-editor.org/rfc/rfc7231) has explicitly defined semantics for request bodies.
/// In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers.
#[serde(skip_serializing_if = "Option::is_none")]
#[serde(rename = "requestBody")]
pub request_body: Option<RefOr<RequestBody>>,
/// **Required** The list of possible responses as they are returned from executing this operation.
pub responses: Responses,
/// A map of possible out-of band callbacks related to the parent operation.
/// The key is a unique identifier for the Callback Object.
/// Each value in the map is a Callback Object that describes a request that
/// may be initiated by the API provider and the expected responses.
#[serde(skip_serializing_if = "Option::is_none")]
pub callbacks: Option<BTreeMap<String, RefOr<Callback>>>,
/// 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 mechanisms can be used for this operation.
/// The list of values includes alternative security requirement objects that can be used.
/// Only one of the security requirement objects need to be satisfied to authorize a request.
/// To make security optional, an empty security requirement (`{}`) can be included in the array.
/// 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>>>>,
/// An alternative `server` array to service this operation.
/// If an alternative `server` object is specified at the Path Item Object or Root level,
/// it will be overridden by this value.
#[serde(skip_serializing_if = "Option::is_none")]
pub servers: Option<Vec<Server>>,
/// 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) {
// do not validate operation_id, it is already validated in PathItem
if let Some(tags) = &self.tags {
for (i, tag) in tags.iter().enumerate() {
let path = format!("{path}.tags[{i}]");
validate_required_string(tag, ctx, path.clone());
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, format_args!(".tags[{i}]: `{tag}` not found in spec"));
}
}
}
if let Some(parameters) = &self.parameters {
for (i, parameter) in parameters.clone().iter().enumerate() {
parameter.validate_with_context(ctx, format!("{path}.parameters[{i}]"));
}
}
if let Some(request_body) = &self.request_body {
request_body.validate_with_context(ctx, format!("{path}.requestBody"));
}
if let Some(servers) = &self.servers {
for (i, server) in servers.iter().enumerate() {
server.validate_with_context(ctx, format!("{path}.servers[{i}]"));
}
}
if let Some(callbacks) = &self.callbacks {
for (k, v) in callbacks {
v.validate_with_context(ctx, format!("{path}.callbacks[{k}]"));
}
}
self.responses
.validate_with_context(ctx, format!("{path}.responses"));
if let Some(external_doc) = &self.external_docs {
external_doc.validate_with_context(ctx, format!("{path}.externalDocs"));
}
if let Some(security) = &self.security {
for (i, security) in security.iter().enumerate() {
for (name, scopes) in security {
let path = format!("{path}.security[{i}][{name}]");
let reference = format!("#/components/securitySchemes/{name}");
let spec_ref = RefOr::<SecurityScheme>::new_ref(reference.clone());
spec_ref.validate_with_context(ctx, path.clone());
if !scopes.is_empty()
&& let Ok(SecurityScheme::OAuth2(oauth2)) = spec_ref.get_item(ctx.spec)
{
for scope in scopes {
ctx.visit(format!("{reference}/{scope}"));
let mut found = false;
if let Some(flow) = &oauth2.flows.implicit {
found = found || flow.scopes.contains_key(scope)
}
if !found && let Some(flow) = &oauth2.flows.password {
found = found || flow.scopes.contains_key(scope)
}
if !found && let Some(flow) = &oauth2.flows.client_credentials {
found = found || flow.scopes.contains_key(scope)
}
if !found && let Some(flow) = &oauth2.flows.authorization_code {
found = found || flow.scopes.contains_key(scope)
}
if !found {
ctx.error(
path.clone(),
format_args!(
"scope `{scope}` not found in spec by reference `{reference}`"
),
);
}
}
}
}
}
}
}
}