-
-
Notifications
You must be signed in to change notification settings - Fork 554
/
openapi.go
329 lines (292 loc) · 18.9 KB
/
openapi.go
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
package openapiv3
import "goa.design/goa/v3/http/codegen/openapi"
type (
// OpenAPI is a data structure that encodes the information needed to
// generate an OpenAPI specification as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md
OpenAPI struct {
OpenAPI string `json:"openapi" yaml:"openapi"` // Required
Info *Info `json:"info" yaml:"info"` // Required
Servers []*Server `json:"servers,omitempty" yaml:"servers,omitempty"`
Paths map[string]*PathItem `json:"paths" yaml:"paths"` // Required
Components *Components `json:"components,omitempty" yaml:"components,omitempty"`
Tags []*openapi.Tag `json:"tags,omitempty" yaml:"tags,omitempty"`
Security []map[string][]string `json:"security,omitempty" yaml:"security,omitempty"`
ExternalDocs *openapi.ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Info represents an OpenAPI Info object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#infoObject
Info struct {
Title string `json:"title" yaml:"title"` // Required
Description string `json:"description,omitempty" yaml:"description,omitempty"`
TermsOfService string `json:"termsOfService,omitempty" yaml:"termsOfService,omitempty"`
Contact *Contact `json:"contact,omitempty" yaml:"contact,omitempty"`
License *License `json:"license,omitempty" yaml:"license,omitempty"`
Version string `json:"version" yaml:"version"` // Required
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Server represents an OpenAPI Server object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#serverObject
Server struct {
URL string `json:"url" yaml:"url"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Variables map[string]*ServerVariable `json:"variables,omitempty" yaml:"variables,omitempty"`
}
// PathItem represents an OpenAPI Path Item object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#pathItemObject
PathItem struct {
Ref string `json:"$ref,omitempty" yaml:"$ref,omitempty"`
Summary string `json:"summary,omitempty" yaml:"summary,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Connect *Operation `json:"connect,omitempty" yaml:"connect,omitempty"`
Delete *Operation `json:"delete,omitempty" yaml:"delete,omitempty"`
Get *Operation `json:"get,omitempty" yaml:"get,omitempty"`
Head *Operation `json:"head,omitempty" yaml:"head,omitempty"`
Options *Operation `json:"options,omitempty" yaml:"options,omitempty"`
Patch *Operation `json:"patch,omitempty" yaml:"patch,omitempty"`
Post *Operation `json:"post,omitempty" yaml:"post,omitempty"`
Put *Operation `json:"put,omitempty" yaml:"put,omitempty"`
Trace *Operation `json:"trace,omitempty" yaml:"trace,omitempty"`
Servers []*Server `json:"servers,omitempty" yaml:"servers,omitempty"`
Parameters []*ParameterRef `json:"parameters,omitempty" yaml:"parameters,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Components represents an OpenAPI Components object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#componentsObject
Components struct {
Schemas map[string]*openapi.Schema `json:"schemas,omitempty" yaml:"schemas,omitempty"`
Parameters map[string]*ParameterRef `json:"parameters,omitempty" yaml:"parameters,omitempty"`
Headers map[string]*HeaderRef `json:"headers,omitempty" yaml:"headers,omitempty"`
RequestBodies map[string]*RequestBodyRef `json:"requestBodies,omitempty" yaml:"requestBodies,omitempty"`
Responses map[string]*ResponseRef `json:"responses,omitempty" yaml:"responses,omitempty"`
SecuritySchemes map[string]*SecuritySchemeRef `json:"securitySchemes,omitempty" yaml:"securitySchemes,omitempty"`
Examples map[string]*ExampleRef `json:"examples,omitempty" yaml:"examples,omitempty"`
Links map[string]*LinkRef `json:"links,omitempty" yaml:"links,omitempty"`
Callbacks map[string]*CallbackRef `json:"callbacks,omitempty" yaml:"callbacks,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Contact represents an OpenAPI Contact object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#contactObject
Contact struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"`
URL string `json:"url,omitempty" yaml:"url,omitempty"`
Email string `json:"email,omitempty" yaml:"email,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// License represents an OpenAPI License object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#licenseObject
License struct {
Name string `json:"name" yaml:"name"` // Required
URL string `json:"url,omitempty" yaml:"url,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// ServerVariable represents an OpenAPI Server Variable object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#serverVariableObject
ServerVariable struct {
Enum []interface{} `json:"enum,omitempty" yaml:"enum,omitempty"`
Default interface{} `json:"default,omitempty" yaml:"default,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
}
// Operation represents an OpenAPI Operation object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#operationObject
Operation struct {
Tags []string `json:"tags,omitempty" yaml:"tags,omitempty"`
Summary string `json:"summary,omitempty" yaml:"summary,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
OperationID string `json:"operationId,omitempty" yaml:"operationId,omitempty"`
Parameters []*ParameterRef `json:"parameters,omitempty" yaml:"parameters,omitempty"`
RequestBody *RequestBodyRef `json:"requestBody,omitempty" yaml:"requestBody,omitempty"`
Responses map[string]*ResponseRef `json:"responses" yaml:"responses"` // Required
Callbacks map[string]*CallbackRef `json:"callbacks,omitempty" yaml:"callbacks,omitempty"`
Deprecated bool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
Security []map[string][]string `json:"security,omitempty" yaml:"security,omitempty"`
Servers []*Server `json:"servers,omitempty" yaml:"servers,omitempty"`
ExternalDocs *openapi.ExternalDocs `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Parameter represents an OpenAPI Parameter object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#parameterObject
Parameter struct {
Name string `json:"name,omitempty" yaml:"name,omitempty"`
In string `json:"in,omitempty" yaml:"in,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Style string `json:"style,omitempty" yaml:"style,omitempty"`
Explode *bool `json:"explode,omitempty" yaml:"explode,omitempty"`
AllowEmptyValue bool `json:"allowEmptyValue,omitempty" yaml:"allowEmptyValue,omitempty"`
AllowReserved bool `json:"allowReserved,omitempty" yaml:"allowReserved,omitempty"`
Deprecated bool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
Required bool `json:"required,omitempty" yaml:"required,omitempty"`
Schema *openapi.Schema `json:"schema,omitempty" yaml:"schema,omitempty"`
Example interface{} `json:"example,omitempty" yaml:"example,omitempty"`
Examples map[string]*ExampleRef `json:"examples,omitempty" yaml:"examples,omitempty"`
Content map[string]*MediaType `json:"content,omitempty" yaml:"content,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Response represents an OpenAPI Response object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#responseObject
Response struct {
Description *string `json:"description,omitempty" yaml:"description,omitempty"`
Headers map[string]*HeaderRef `json:"headers,omitempty" yaml:"headers,omitempty"`
Content map[string]*MediaType `json:"content,omitempty" yaml:"content,omitempty"`
Links map[string]*LinkRef `json:"links,omitempty" yaml:"links,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// MediaType represents an OpenAPI Media Type object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#mediaTypeObject
MediaType struct {
Schema *openapi.Schema `json:"schema,omitempty" yaml:"schema,omitempty"`
Example interface{} `json:"example,omitempty" yaml:"example,omitempty"`
Examples map[string]*ExampleRef `json:"examples,omitempty" yaml:"examples,omitempty"`
Encoding map[string]*Encoding `json:"encoding,omitempty" yaml:"encoding,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Encoding represents an OpenAPI Encoding object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#encodingObject
Encoding struct {
ContentType string `json:"contentType,omitempty" yaml:"contentType,omitempty"`
Headers map[string]*HeaderRef `json:"headers,omitempty" yaml:"headers,omitempty"`
Style string `json:"style,omitempty" yaml:"style,omitempty"`
Explode *bool `json:"explode,omitempty" yaml:"explode,omitempty"`
AllowReserved bool `json:"allowReserved,omitempty" yaml:"allowReserved,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Header represents an OpenAPI Header object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#headerObject
Header struct {
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Style string `json:"style,omitempty" yaml:"style,omitempty"`
Explode *bool `json:"explode,omitempty" yaml:"explode,omitempty"`
AllowEmptyValue bool `json:"allowEmptyValue,omitempty" yaml:"allowEmptyValue,omitempty"`
AllowReserved bool `json:"allowReserved,omitempty" yaml:"allowReserved,omitempty"`
Deprecated bool `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
Required bool `json:"required,omitempty" yaml:"required,omitempty"`
Schema *openapi.Schema `json:"schema,omitempty" yaml:"schema,omitempty"`
Example interface{} `json:"example,omitempty" yaml:"example,omitempty"`
Examples map[string]*ExampleRef `json:"examples,omitempty" yaml:"examples,omitempty"`
Content map[string]*MediaType `json:"content,omitempty" yaml:"content,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Link represents an OpenAPI Link object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#linkObject
Link struct {
OperationID string `json:"operationId,omitempty" yaml:"operationId,omitempty"`
OperationRef string `json:"operationRef,omitempty" yaml:"operationRef,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Parameters map[string]interface{} `json:"parameters,omitempty" yaml:"parameters,omitempty"`
Server *Server `json:"server,omitempty" yaml:"server,omitempty"`
RequestBody interface{} `json:"requestBody,omitempty" yaml:"requestBody,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// Example represents an OpenAPI Example object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#exampleObject
Example struct {
Summary string `json:"summary,omitempty" yaml:"summary,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Value interface{} `json:"value,omitempty" yaml:"value,omitempty"`
ExternalValue string `json:"externalValue,omitempty" yaml:"externalValue,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// RequestBody represents an OpenAPI RequestBody object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#requestBodyObject
RequestBody struct {
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Required bool `json:"required,omitempty" yaml:"required,omitempty"`
Content map[string]*MediaType `json:"content,omitempty" yaml:"content,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// SecurityScheme represents an OpenAPI SecurityScheme object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#securitySchemeObject
SecurityScheme struct {
Type string `json:"type,omitempty" yaml:"type,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Name string `json:"name,omitempty" yaml:"name,omitempty"`
In string `json:"in,omitempty" yaml:"in,omitempty"`
Scheme string `json:"scheme,omitempty" yaml:"scheme,omitempty"`
BearerFormat string `json:"bearerFormat,omitempty" yaml:"bearerFormat,omitempty"`
Flows *OAuthFlows `json:"flows,omitempty" yaml:"flows,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// OAuthFlows represents an OpenAPI OAuthFlows object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#oauthFlowsObject
OAuthFlows struct {
Implicit *OAuthFlow `json:"implicit,omitempty" yaml:"implicit,omitempty"`
Password *OAuthFlow `json:"password,omitempty" yaml:"password,omitempty"`
ClientCredentials *OAuthFlow `json:"clientCredentials,omitempty" yaml:"clientCredentials,omitempty"`
AuthorizationCode *OAuthFlow `json:"authorizationCode,omitempty" yaml:"authorizationCode,omitempty"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// OAuthFlow represents an OpenAPI OAuthFlow object as defined in
// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#oauthFlowObject
OAuthFlow struct {
AuthorizationURL string `json:"authorizationUrl,omitempty" yaml:"authorizationUrl,omitempty"`
TokenURL string `json:"tokenUrl,omitempty" yaml:"tokenUrl,omitempty"`
RefreshURL string `json:"refreshUrl,omitempty" yaml:"refreshUrl,omitempty"`
Scopes map[string]string `json:"scopes" yaml:"scopes"`
Extensions map[string]interface{} `json:"-" yaml:"-"`
}
// These types are used in openapi.MarshalJSON() to avoid recursive call of json.Marshal().
_Info Info
_PathItem PathItem
_Operation Operation
_Parameter Parameter
_Response Response
_SecurityScheme SecurityScheme
)
// MediaType implements exampler
func (m *MediaType) setExample(val interface{}) { m.Example = val }
func (m *MediaType) setExamples(val map[string]*ExampleRef) { m.Examples = val }
// Header implements exampler
func (h *Header) setExample(val interface{}) { h.Example = val }
func (h *Header) setExamples(val map[string]*ExampleRef) { h.Examples = val }
// Parameter implements exampler
func (p *Parameter) setExample(val interface{}) { p.Example = val }
func (p *Parameter) setExamples(val map[string]*ExampleRef) { p.Examples = val }
// MarshalJSON returns the JSON encoding of i.
func (i Info) MarshalJSON() ([]byte, error) {
return openapi.MarshalJSON(_Info(i), i.Extensions)
}
// MarshalJSON returns the JSON encoding of p.
func (p PathItem) MarshalJSON() ([]byte, error) {
return openapi.MarshalJSON(_PathItem(p), p.Extensions)
}
// MarshalJSON returns the JSON encoding of o.
func (o Operation) MarshalJSON() ([]byte, error) {
return openapi.MarshalJSON(_Operation(o), o.Extensions)
}
// MarshalJSON returns the JSON encoding of p.
func (p Parameter) MarshalJSON() ([]byte, error) {
return openapi.MarshalJSON(_Parameter(p), p.Extensions)
}
// MarshalJSON returns the JSON encoding of r.
func (r Response) MarshalJSON() ([]byte, error) {
return openapi.MarshalJSON(_Response(r), r.Extensions)
}
// MarshalJSON returns the JSON encoding of s.
func (s SecurityScheme) MarshalJSON() ([]byte, error) {
return openapi.MarshalJSON(_SecurityScheme(s), s.Extensions)
}
// MarshalYAML returns value which marshaled in place of the original value
func (i Info) MarshalYAML() (interface{}, error) {
return openapi.MarshalYAML(_Info(i), i.Extensions)
}
// MarshalYAML returns value which marshaled in place of the original value
func (p PathItem) MarshalYAML() (interface{}, error) {
return openapi.MarshalYAML(_PathItem(p), p.Extensions)
}
// MarshalYAML returns value which marshaled in place of the original value
func (o Operation) MarshalYAML() (interface{}, error) {
return openapi.MarshalYAML(_Operation(o), o.Extensions)
}
// MarshalYAML returns value which marshaled in place of the original value
func (p Parameter) MarshalYAML() (interface{}, error) {
return openapi.MarshalYAML(_Parameter(p), p.Extensions)
}
// MarshalYAML returns value which marshaled in place of the original value
func (r Response) MarshalYAML() (interface{}, error) {
return openapi.MarshalYAML(_Response(r), r.Extensions)
}
// MarshalYAML returns value which marshaled in place of the original value
func (s SecurityScheme) MarshalYAML() (interface{}, error) {
return openapi.MarshalYAML(_SecurityScheme(s), s.Extensions)
}