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
//! `OpenAPI` response and request body building.
use fraiseql_core::schema::{DeleteResponse, MutationDefinition, TypeDefinition};
use serde_json::{Map, Value, json};
use super::{OpenApiGenerator, format::field_type_to_json_schema};
use crate::routes::rest::resource::{HttpMethod, RestResource, RestRoute, RouteSource};
impl OpenApiGenerator<'_> {
/// Build the `responses` object for a route.
#[allow(clippy::too_many_lines)] // Reason: response building requires handling each HTTP method
pub(super) fn build_responses(&self, resource: &RestResource, route: &RestRoute) -> Value {
let mut responses = Map::new();
let type_ref = format!("#/components/schemas/{}", resource.type_name);
match route.method {
HttpMethod::Get => {
let is_list = matches!(&route.source, RouteSource::Query { name }
if self.schema.queries.iter()
.find(|q| q.name == *name)
.is_some_and(|q| q.returns_list));
if is_list {
responses.insert(
"200".to_string(),
json!({
"description": format!("List of {}", resource.name),
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": { "$ref": type_ref }
},
"meta": {
"type": "object",
"properties": {
"total": { "type": "integer" },
"limit": { "type": "integer" },
"offset": { "type": "integer" }
}
},
"links": {
"type": "object",
"properties": {
"self": { "type": "string" },
"next": { "type": "string" },
"prev": { "type": "string" }
}
}
}
}
},
"application/x-ndjson": {
"description": "Newline-delimited JSON stream (one object per line, no envelope)",
"schema": { "$ref": type_ref }
}
}
}),
);
} else {
responses.insert(
"200".to_string(),
json!({
"description": resource.type_name,
"content": {
"application/json": {
"schema": { "$ref": type_ref }
}
}
}),
);
responses.insert(
"304".to_string(),
json!({ "description": "Not Modified (ETag match)" }),
);
responses.insert("404".to_string(), json!({ "description": "Not found" }));
}
},
HttpMethod::Post => {
let status = route.success_status.to_string();
responses.insert(
status,
json!({
"description": format!("{} created/executed", resource.type_name),
"content": {
"application/json": {
"schema": { "$ref": type_ref }
}
},
"headers": {
"Location": {
"description": "URL of the created resource",
"schema": { "type": "string" }
}
}
}),
);
},
HttpMethod::Put | HttpMethod::Patch => {
responses.insert(
"200".to_string(),
json!({
"description": format!("Updated {}", resource.type_name),
"content": {
"application/json": {
"schema": { "$ref": type_ref }
}
}
}),
);
if route.method == HttpMethod::Put {
responses.insert(
"422".to_string(),
json!({ "description": "Unprocessable entity (missing required fields)" }),
);
}
responses.insert("404".to_string(), json!({ "description": "Not found" }));
},
HttpMethod::Delete => {
match self.config.delete_response {
DeleteResponse::NoContent => {
responses.insert(
"204".to_string(),
json!({ "description": "Deleted (no content)" }),
);
},
DeleteResponse::Entity | _ => {
responses.insert(
"200".to_string(),
json!({
"description": format!("Deleted {}", resource.type_name),
"content": {
"application/json": {
"schema": { "$ref": type_ref }
}
}
}),
);
},
}
responses.insert("404".to_string(), json!({ "description": "Not found" }));
},
}
// Common error responses.
if !responses.contains_key("400") {
responses.insert("400".to_string(), json!({ "description": "Bad request" }));
}
if self.config.require_auth {
responses.insert("401".to_string(), json!({ "description": "Unauthorized" }));
responses.insert("403".to_string(), json!({ "description": "Forbidden" }));
}
Value::Object(responses)
}
/// Build the `requestBody` for a mutating route, or `None` for GET/DELETE.
pub(super) fn build_request_body(
&self,
resource: &RestResource,
route: &RestRoute,
) -> Option<Value> {
match route.method {
HttpMethod::Post | HttpMethod::Put | HttpMethod::Patch => {},
_ => return None,
}
let RouteSource::Mutation { name } = &route.source else {
return None;
};
let mutation = self.schema.mutations.iter().find(|m| m.name == *name)?;
let type_def = self.schema.find_type(&resource.type_name);
let schema = match route.method {
HttpMethod::Post => {
let single = self.mutation_args_schema(mutation);
json!({
"oneOf": [
single,
{
"type": "array",
"items": single,
"description": "Array body triggers bulk insert mode"
}
]
})
},
HttpMethod::Put => {
if let Some(td) = type_def {
self.writable_fields_schema(td, true)
} else {
self.mutation_args_schema(mutation)
}
},
HttpMethod::Patch => {
if let Some(td) = type_def {
self.writable_fields_schema(td, false)
} else {
self.mutation_args_schema(mutation)
}
},
_ => return None,
};
Some(json!({
"required": true,
"content": {
"application/json": {
"schema": schema,
}
}
}))
}
/// Build a JSON Schema object for mutation arguments.
pub(super) fn mutation_args_schema(&self, mutation: &MutationDefinition) -> Value {
let mut properties = Map::new();
let mut required = Vec::new();
for arg in &mutation.arguments {
if arg.name == "id" || arg.name.starts_with("pk_") {
continue;
}
properties.insert(arg.name.clone(), field_type_to_json_schema(&arg.arg_type));
if !arg.nullable {
required.push(json!(arg.name));
}
}
let mut schema = json!({
"type": "object",
"properties": properties,
});
if !required.is_empty() {
schema["required"] = Value::Array(required);
}
schema
}
/// Build a JSON Schema object for writable fields (PUT = all required, PATCH = none required).
pub(super) fn writable_fields_schema(
&self,
type_def: &TypeDefinition,
all_required: bool,
) -> Value {
let writable = type_def.writable_fields();
let mut properties = Map::new();
let mut required = Vec::new();
for field in &writable {
properties.insert(field.name.to_string(), field_type_to_json_schema(&field.field_type));
if all_required && !field.nullable {
required.push(json!(field.name.to_string()));
}
}
let mut schema = json!({
"type": "object",
"properties": properties,
});
if !required.is_empty() {
schema["required"] = Value::Array(required);
}
schema
}
}