-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathOperationRepresentable.swift
More file actions
258 lines (221 loc) · 8.01 KB
/
OperationRepresentable.swift
File metadata and controls
258 lines (221 loc) · 8.01 KB
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
//
// OperationRepresentable.swift
// feather-openapi
//
// Created by Tibor Bödecs on 2026. 01. 21.
//
import OpenAPIKit30
extension String {
fileprivate func lowercasedFirstLetter() -> String {
guard !isEmpty else {
return self
}
return prefix(1).lowercased() + dropFirst()
}
}
/// Describes an OpenAPI operation with defaults and reference aggregation.
public protocol OperationRepresentable:
OpenAPIOperationRepresentable,
// properties
DescriptionProperty,
DeprecatedProperty,
VendorExtensionsProperty,
// references
ReferencedSchemaMapRepresentable,
ReferencedHeaderMapRepresentable,
ReferencedRequestBodyMapRepresentable,
ReferencedParameterMapRepresentable,
ReferencedResponseMapRepresentable,
ReferencedTagMapRepresentable,
ReferencedSecuritySchemeMapRepresentable
{
// associatedtype RequestBodyType: RequestBodyRepresentable
/// Tags associated with the operation.
var tags: [TagRepresentable] { get }
/// Short summary of the operation.
var summary: String? { get }
/// Optional explicit operation identifier.
var operationId: String? { get }
/// Parameters accepted by the operation.
var parameters: [ParameterRepresentable] { get }
/// Optional request body.
var requestBody: RequestBodyRepresentable? { get }
/// Response map keyed by status code.
var responseMap: ResponseMap { get }
/// Optional security requirements.
var security: [SecurityRequirementRepresentable]? { get }
/// Optional per-operation servers.
var servers: [ServerRepresentable]? { get }
}
extension OperationRepresentable {
/// Default tags are empty.
public var tags: [TagRepresentable] { [] }
/// Default summary is `nil`.
public var summary: String? { nil }
/// Computes a default operation identifier from the type name.
public var operationId: String? {
let suffix = "Operation"
let operationTypeName = String(reflecting: type(of: self))
.split(separator: ".")
.filter { $0.hasSuffix(suffix) }
.map(String.init)
.joined(separator: "")
guard !operationTypeName.isEmpty else {
return nil
}
let typeName = operationTypeName.dropLast(suffix.count)
guard !typeName.isEmpty else {
return nil
}
return String(typeName).lowercasedFirstLetter()
}
/// Default parameters are empty.
public var parameters: [ParameterRepresentable] { [] }
/// Default request body is `nil`.
public var requestBody: RequestBodyRepresentable? { nil }
/// Default security requirements are `nil`.
public var security: [SecurityRequirementRepresentable]? { nil }
/// Default servers list is `nil`.
public var servers: [ServerRepresentable]? { nil }
private var openAPITags: [String]? {
tags.isEmpty ? nil : tags.map { $0.name }
}
private var openAPISecurityRequirements: [OpenAPI.SecurityRequirement]? {
guard let security, !security.isEmpty else {
return nil
}
return security.map { $0.openAPISecurityRequirement() }
}
/// Builds an OpenAPI operation.
/// - Returns: The OpenAPI operation.
public func openAPIOperation() -> OpenAPI.Operation {
if let requestBody {
return .init(
tags: openAPITags,
summary: summary,
description: description,
externalDocs: nil,
operationId: operationId,
parameters: parameters.map { $0.openAPIParameter() },
requestBody: requestBody.openAPIRequestBody(),
responses: responseMap.mapValues { $0.openAPIResponse() },
callbacks: [:],
deprecated: deprecated,
security: openAPISecurityRequirements,
servers: servers?.map { $0.openAPIServer() },
vendorExtensions: vendorExtensions
)
}
return .init(
tags: openAPITags,
summary: summary,
description: description,
externalDocs: nil,
operationId: operationId,
parameters: parameters.map { $0.openAPIParameter() },
responses: responseMap.mapValues { $0.openAPIResponse() },
callbacks: [:],
deprecated: deprecated,
security: openAPISecurityRequirements,
servers: servers?.map { $0.openAPIServer() },
vendorExtensions: vendorExtensions
)
}
// MARK: - refs
/// Aggregated referenced schemas from parameters, request body, and responses.
public var referencedSchemaMap:
OrderedDictionary<SchemaID, OpenAPISchemaRepresentable>
{
var results = OrderedDictionary<SchemaID, OpenAPISchemaRepresentable>()
for parameter in parameters {
results.merge(parameter.referencedSchemaMap)
}
if let schemaMap = requestBody?.referencedSchemaMap {
results.merge(schemaMap)
}
let headers = responseMap.values
.map { $0.headerMap.values }
.flatMap { $0 }
for header in headers {
results.merge(header.referencedSchemaMap)
}
let contents = responseMap.values
.map { $0.contentMap.values }
.flatMap { $0 }
for content in contents {
results.merge(content.referencedSchemaMap)
}
return results
}
/// Aggregated referenced parameters used by the operation.
public var referencedParameterMap:
OrderedDictionary<ParameterID, OpenAPIParameterRepresentable>
{
var results = OrderedDictionary<
ParameterID, OpenAPIParameterRepresentable
>()
for parameter in parameters {
if let ref = parameter as? ParameterReferenceRepresentable {
if case .b(let parameter) = ref.object.openAPIParameter() {
results[ref.id] = parameter
}
}
}
return results
}
/// Aggregated referenced request bodies used by the operation.
public var referencedRequestBodyMap:
OrderedDictionary<RequestBodyID, OpenAPIRequestBodyRepresentable>
{
var results = OrderedDictionary<
RequestBodyID, OpenAPIRequestBodyRepresentable
>()
if let ref = requestBody as? RequestBodyReferenceRepresentable {
results[ref.id] = ref.object
}
return results
}
/// Aggregated referenced headers used by responses.
public var referencedHeaderMap:
OrderedDictionary<HeaderID, OpenAPIHeaderRepresentable>
{
var results = OrderedDictionary<HeaderID, OpenAPIHeaderRepresentable>()
let headers = responseMap.values
.map { $0.headerMap.values }
.flatMap { $0 }
for header in headers {
if let ref = header as? HeaderReferenceRepresentable {
if case .b(let header) = ref.object.openAPIHeader() {
results[ref.id] = header
}
}
}
return results
}
/// Aggregated referenced responses used by the operation.
public var referencedResponseMap:
OrderedDictionary<ResponseID, OpenAPIResponseRepresentable>
{
var results = OrderedDictionary<
ResponseID, OpenAPIResponseRepresentable
>()
for response in responseMap.values {
if let ref = response as? ResponseReferenceRepresentable {
if case .b(let response) = ref.object.openAPIResponse() {
results[ref.id] = response
}
}
}
return results
}
/// Referenced tags for the operation.
public var referencedTags: [OpenAPITagRepresentable] {
tags
}
/// Referenced security requirements for the operation.
public var referencedSecurityRequirements:
[SecurityRequirementRepresentable]
{
security?.map { $0 } ?? []
}
}