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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
|
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
description: Swagger Petstore API specification
termsOfService: Fair use
contact:
name: Author
url: http://petstore.swagger.io
email: email@petstore.swagger.io
license:
name: MIT
url: https://opensource.org/licenses/MIT
security:
- api_key: []
- {}
servers:
- url: http://petstore.swagger.io/{version}
variables:
version:
enum:
- v1
- v2
default: v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: page
in: query
schema:
type: integer
format: int32
default: 1
- name: limit
in: query
style: form
description: How many items to return at one time (max 100)
required: true
deprecated: true
schema:
type: integer
format: int32
nullable: true
- name: search
in: query
description: Search query
schema:
type: string
default: ""
allowEmptyValue: true
- name: ids
in: query
description: Filter pets with Ids
schema:
type: array
items:
type: integer
format: int32
- name: order
in: query
schema:
oneOf:
- type: string
- type: integer
format: int32
- name: tags
in: query
description: Filter pets with tags
schema:
type: array
items:
$ref: "#/components/schemas/Tag"
explode: false
- name: coordinates
in: query
content:
application/json:
schema:
$ref: "#/components/schemas/Coordinates"
- name: color
in: query
description: RGB color
style: deepObject
required: false
explode: true
schema:
type: object
properties:
R:
type: integer
G:
type: integer
B:
type: integer
responses:
'200':
$ref: "#/components/responses/PetsResponse"
'400':
$ref: "#/components/responses/ErrorResponse"
'404':
$ref: "#/components/responses/HtmlResponse"
post:
summary: Create a pet
description: Creates new pet entry
externalDocs:
url: https://example.com
description: Find more info here
servers:
- url: https://development.gigantic-server.com/v1
description: Development server
- url: https://staging.gigantic-server.com/v1
description: Staging server
operationId: createPets
tags:
- pets
parameters:
- name: api-key
in: header
schema:
type: string
format: byte
required: true
- name: user
in: cookie
schema:
type: integer
format: int32
required: true
- name: userdata
in: cookie
content:
application/json:
schema:
$ref: '#/components/schemas/Userdata'
required: false
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PetCreate'
example:
name: "Pet"
wings: []
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PetCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/PetWithPhotoCreate'
text/plain: {}
responses:
'201':
description: Null response
default:
$ref: "#/components/responses/ErrorResponse"
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: integer
format: int64
security:
- petstore_auth:
- write:pets
- read:pets
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/PetData"
example: |
{
"data": []
}
image/*:
schema:
type: string
format: binary
default:
$ref: "#/components/responses/ErrorResponse"
/pets/{petId}/photo:
get:
summary: Photo for a specific pet
operationId: showPetPhotoById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: integer
format: int64
responses:
'200':
description: Expected response to a valid request
content:
image/*:
schema:
type: string
format: binary
default:
$ref: "#/components/responses/ErrorResponse"
post:
summary: Create a pet photo
description: Creates new pet photo entry
operationId: createPetPhotoById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: integer
format: int64
requestBody:
required: true
content:
image/*:
schema:
type: string
format: binary
responses:
'201':
description: Null response
default:
$ref: "#/components/responses/ErrorResponse"
/tags:
get:
summary: List all tags
operationId: listTags
tags:
- tags
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: "#/components/schemas/TagList"
example:
- dogs
- cats
default:
$ref: "#/components/responses/ErrorResponse"
post:
summary: Create new tag
operationId: createTag
tags:
- tags
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TagCreate'
responses:
'200':
description: Null response
default:
$ref: "#/components/responses/ErrorResponse"
delete:
summary: Delete tags
operationId: deleteTag
tags:
- tags
parameters:
- name: x-delete-force
in: header
schema:
type: boolean
required: false
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/TagDelete'
responses:
'200':
description: Null response
headers:
x-delete-confirm:
description: Confirmation automation
deprecated: true
schema:
type: boolean
required: true
x-delete-date:
description: Confirmation automation date
schema:
type: string
format: date
default:
$ref: "#/components/responses/ErrorResponse"
components:
schemas:
Coordinates:
x-model: Coordinates
type: object
required:
- lat
- lon
properties:
lat:
type: number
lon:
type: number
Userdata:
x-model: Userdata
type: object
required:
- name
properties:
name:
type: string
Utctime:
oneOf:
- type: string
enum: [always, now]
- type: string
format: date-time
Address:
type: object
x-model: Address
required:
- city
properties:
street:
type: string
city:
type: string
Tag:
type: string
enum:
- cats
- dogs
- birds
Position:
type: integer
enum:
- 1
- 2
- 3
Pet:
type: object
x-model: Pet
allOf:
- $ref: "#/components/schemas/PetCreate"
required:
- id
properties:
id:
type: integer
format: int64
PetCreate:
type: object
x-model: PetCreate
allOf:
- $ref: "#/components/schemas/PetCreatePartOne"
- $ref: "#/components/schemas/PetCreatePartTwo"
oneOf:
- $ref: "#/components/schemas/Cat"
- $ref: "#/components/schemas/Bird"
PetWithPhotoCreate:
type: object
x-model: PetWithPhotoCreate
allOf:
- $ref: "#/components/schemas/PetCreatePartOne"
- $ref: "#/components/schemas/PetCreatePartTwo"
- $ref: "#/components/schemas/PetCreatePartPhoto"
oneOf:
- $ref: "#/components/schemas/Cat"
- $ref: "#/components/schemas/Bird"
PetCreatePartOne:
type: object
x-model: PetCreatePartOne
required:
- name
properties:
name:
type: string
tag:
$ref: "#/components/schemas/Tag"
address:
$ref: "#/components/schemas/Address"
PetCreatePartTwo:
type: object
x-model: PetCreatePartTwo
properties:
position:
$ref: "#/components/schemas/Position"
healthy:
type: boolean
PetCreatePartPhoto:
type: object
x-model: PetCreatePartPhoto
properties:
photo:
$ref: "#/components/schemas/PetPhoto"
PetPhoto:
type: string
format: binary
Bird:
type: object
x-model: Bird
required:
- wings
properties:
wings:
$ref: "#/components/schemas/Wings"
Wings:
type: object
x-model: Wings
required:
- healthy
properties:
healthy:
type: boolean
Cat:
type: object
x-model: Cat
required:
- ears
properties:
ears:
$ref: "#/components/schemas/Ears"
Ears:
type: object
x-model: Ears
required:
- healthy
properties:
healthy:
type: boolean
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
PetsData:
type: object
x-model: PetsData
required:
- data
properties:
data:
$ref: "#/components/schemas/Pets"
PetData:
type: object
x-model: PetData
required:
- data
properties:
data:
$ref: "#/components/schemas/Pet"
TagCreate:
type: object
x-model: TagCreate
required:
- name
properties:
created:
$ref: "#/components/schemas/Utctime"
name:
type: string
additionalProperties: false
TagDelete:
type: object
x-model: TagDelete
required:
- ids
properties:
ids:
type: array
items:
type: integer
format: int64
additionalProperties: false
TagList:
type: array
items:
$ref: "#/components/schemas/Tag"
Error:
type: object
required:
- message
properties:
code:
type: integer
format: int32
default: 400
message:
type: string
StandardError:
type: object
x-model: StandardError
required:
- title
- status
- type
properties:
title:
type: string
status:
type: integer
format: int32
default: 400
type:
type: string
StandardErrors:
type: object
required:
- errors
properties:
errors:
type: array
items:
$ref: "#/components/schemas/StandardError"
ExtendedError:
type: object
x-model: ExtendedError
allOf:
- $ref: "#/components/schemas/Error"
- type: object
required:
- rootCause
properties:
correlationId:
type: string
format: uuid
rootCause:
type: string
suberror:
$ref: "#/components/schemas/ExtendedError"
additionalProperties:
oneOf:
- type: string
- type: integer
format: int32
responses:
ErrorResponse:
description: unexpected error
content:
application/json:
schema:
x-model: Error
oneOf:
- $ref: "#/components/schemas/StandardErrors"
- $ref: "#/components/schemas/ExtendedError"
HtmlResponse:
description: HTML page
content:
text/html: {}
PetsResponse:
description: An paged array of pets
headers:
content-type:
description: Content type
schema:
type: string
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/PetsData"
securitySchemes:
api_key:
type: apiKey
name: api_key
in: query
petstore_auth:
type: http
scheme: basic
|
