-
Notifications
You must be signed in to change notification settings - Fork 939
/
Copy pathpetstore-3.0.yaml
734 lines (734 loc) · 18.5 KB
/
petstore-3.0.yaml
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
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
openapi: 3.0.0
info:
title: 'Swagger Petstore'
description: "This is a sample Petstore server. You can find\nout more about Swagger at\n[http://swagger.io](http://swagger.io) or on\n[irc.freenode.net, #swagger](http://swagger.io/irc/)."
termsOfService: 'http://swagger.io/terms/'
contact:
email: [email protected]
license:
name: 'Apache 2.0'
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
version: 1.0.0
servers:
-
url: 'https://virtserver.swaggerhub.com/swagger/Petstore/1.0.0'
description: 'SwaggerHUB API Mocking'
paths:
/pet:
put:
tags:
- pet
summary: 'Update an existing pet.'
operationId: updatePet
requestBody:
$ref: '#/components/requestBodies/Pet'
responses:
'400':
description: 'Invalid ID supplied'
'404':
description: 'Pet not found'
'405':
description: 'Validation exception'
security:
-
petstore_auth:
- 'write:pets'
- 'read:pets'
post:
tags:
- pet
summary: 'Add a new pet to the store.'
operationId: addPet
requestBody:
$ref: '#/components/requestBodies/Pet'
responses:
'405':
description: 'Invalid input'
security:
-
petstore_auth:
- 'write:pets'
- 'read:pets'
/pet/findByStatus:
get:
tags:
- pet
summary: 'Finds Pets by status'
description: 'Multiple status values can be provided with comma separated string'
operationId: findPetsByStatus
parameters:
-
name: status
in: query
description: 'Status values that needed to be considered for filter'
required: true
explode: true
schema:
type: string
default: available
enum:
- available
- pending
- sold
responses:
'200':
description: 'successful operation'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
'400':
description: 'Invalid status value'
deprecated: true
security:
-
petstore_auth:
- 'write:pets'
- 'read:pets'
/pet/findByTags:
get:
tags:
- pet
summary: 'Finds Pets by tags'
description: 'Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.'
operationId: findByTags
parameters:
-
name: tags
in: query
description: 'Tags to filter by'
required: true
explode: true
schema:
type: array
items:
type: string
responses:
'200':
description: 'successful operation'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
'400':
description: 'Invalid status value'
security:
-
petstore_auth:
- 'write:pets'
- 'read:pets'
'/pet/{petId}':
get:
tags:
- pet
summary: 'Find pet by ID'
description: 'Returns a single pet'
operationId: getPetById
parameters:
-
name: petId
in: path
description: 'ID of pet to return'
required: true
schema:
type: integer
format: int64
responses:
'200':
description: 'successful operation'
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
application/xml:
schema:
$ref: '#/components/schemas/Pet'
'400':
description: 'Invalid ID supplier'
'404':
description: 'Pet not found'
security:
-
api_key: []
post:
tags:
- pet
summary: 'Updates a pet in the store with form data'
operationId: updatePetWithForm
parameters:
-
name: petId
in: path
description: 'ID of pet that needs to be updated'
required: true
schema:
type: integer
format: int64
requestBody:
description: 'Input data format'
content:
application/x-www-form-urlencoded:
schema:
properties:
name:
description: 'Updated name of the pet'
type: string
status:
description: 'Updated status of the pet'
type: string
type: object
responses:
'405':
description: 'Invalid input'
security:
-
petstore_auth:
- 'write:pets'
- 'read:pets'
delete:
tags:
- pet
summary: 'Deletes a pet'
operationId: deletePet
parameters:
-
name: api_key
in: header
required: false
schema:
type: string
-
name: petId
in: path
description: 'Pet id to delete'
required: true
schema:
type: integer
format: int64
responses:
'400':
description: 'Invalid ID supplied'
'404':
description: 'Pet not found'
security:
-
petstore_auth:
- 'write:pets'
- 'read:pets'
'/pet/{petId}/uploadImage':
post:
tags:
- pet
summary: 'uploads an image'
operationId: uploadFile
parameters:
-
name: petId
in: path
description: 'ID of pet to update'
required: true
schema:
type: integer
format: int64
example: 1
requestBody:
description: 'Upload images request body'
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: 'successful operation'
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
-
petstore_auth:
- 'write:pets'
- 'read:pets'
/store:
get:
tags:
- store
summary: 'Returns pet inventories by status'
description: 'Returns a map of status codes to quantities'
operationId: getInventory
responses:
'200':
description: 'successful operation'
content:
application/json:
schema:
additionalProperties:
type: integer
format: int32
security:
-
api_key: []
/store/order:
post:
tags:
- store
summary: 'Place an order for a pet'
operationId: placeOrder
requestBody:
description: 'order placed for purchasing th pet'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
responses:
'200':
description: 'successful operation'
content:
application/json:
schema:
$ref: '#/components/schemas/Order'
application/xml:
schema:
$ref: '#/components/schemas/Order'
'/store/order/{orderId}':
get:
tags:
- store
description: 'For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions'
operationId: getOrderById
parameters:
-
name: orderId
in: path
description: 'ID of pet that needs to be fetched'
required: true
schema:
type: integer
format: int64
maximum: 10
minimum: 1
responses:
'200':
description: 'successful operation'
content:
application/xml:
schema:
$ref: '#/components/schemas/Order'
application/json:
schema:
$ref: '#/components/schemas/Order'
'400':
description: 'Invalid ID supplied'
'404':
description: 'Order not found'
delete:
tags:
- store
summary: 'Delete purchase order by ID'
description: 'For valid response try integer IDs with positive integer value. Negative or non-integer values will generate API errors'
operationId: deleteOrder
parameters:
-
name: orderId
in: path
description: 'ID of the order that needs to be deleted'
required: true
schema:
type: integer
format: int64
minimum: 1
responses:
'400':
description: 'Invalid ID supplied'
'404':
description: 'Order not found'
/user:
post:
tags:
- user
summary: 'Create user'
description: 'This can only be done by the logged in user.'
operationId: createUser
requestBody:
description: 'Create user object'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
default:
description: 'successful operation'
/user/createWithArray:
post:
tags:
- user
summary: 'Create list of users with given input array'
operationId: createUsersWithListInput
requestBody:
$ref: '#/components/requestBodies/UserArray'
responses:
default:
description: 'successful operation'
/user/login:
get:
tags:
- user
summary: 'Logs user into system'
operationId: loginUser
parameters:
-
name: username
in: query
description: 'The user name for login'
required: true
schema:
type: string
-
name: password
in: query
required: true
schema:
type: string
responses:
'200':
description: 'successful operation'
headers:
X-Rate-Limit:
description: 'calls per hour allowed by the user'
schema:
type: integer
format: int32
X-Expires-After:
description: 'date in UTC when token expires'
schema:
type: string
format: datetime
content:
application/xml:
schema:
type: string
application/json:
schema:
type: string
'400':
description: 'Invalid username/password supplied'
/user/logout:
get:
tags:
- user
summary: 'Logs out current logged in user session'
operationId: logoutUser
responses:
default:
description: 'successful operation'
'/user/{username}':
get:
summary: 'Get user by user name'
operationId: getUserByName
parameters:
-
name: username
in: path
required: true
schema:
type: string
responses:
'200':
description: 'successful operation'
content:
application/xml:
schema:
$ref: '#/components/schemas/User'
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
description: 'Invalid username supplied'
'404':
description: 'User not found'
put:
summary: 'Updated user'
description: 'This can pnly be done by the logged in user.'
operationId: updateUser
parameters:
-
name: username
in: path
description: 'name that to be updated'
required: true
schema:
type: string
requestBody:
description: 'Updated user object'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'400':
description: 'Invalid user supplied'
'404':
description: 'User not found'
delete:
summary: 'Delete user'
description: 'This can only be done by the logged in user.'
operationId: deleteUser
parameters:
-
name: username
in: path
description: 'The name that needs to be deleted'
required: true
schema:
type: string
responses:
'400':
description: 'Invalid username supplied'
'404':
description: 'User not found'
components:
schemas:
ApiResponse:
title: 'Api response'
description: 'Api response'
properties:
code:
title: Code
description: Code
type: integer
format: int32
message:
title: Message
description: Message
type: string
type: object
Category:
title: 'Pets Category.'
description: 'Pets Category.'
properties:
id:
title: ID
description: ID
type: integer
format: int64
name:
title: 'Category name'
description: 'Category name'
type: string
type: object
xml:
name: Category
Order:
title: 'Order model'
description: 'Order model'
properties:
id:
title: ID
description: ID
type: integer
format: int64
default: 1
petId:
title: 'Pet ID'
description: 'Pet ID'
type: integer
format: int64
default: 1
quantity:
title: Quantity
description: Quantity
type: integer
format: in32
default: 12
shipDate:
title: 'Shipping date'
description: 'Shipping date'
type: string
format: datetime
default: '2017-02-02 18:31:45'
status:
title: 'Order status.'
description: 'Order status.'
type: string
default: placed
enum:
- placed
- approved
- delivered
complete:
title: 'Complete status'
description: 'Complete status'
type: boolean
format: int64
default: false
type: object
Pet:
title: 'Pet model'
description: 'Pet model'
required:
- name
- photoUrls
properties:
id:
title: ID
description: ID
type: integer
format: int64
category:
$ref: '#/components/schemas/Category'
name:
title: 'Pet name'
description: 'Pet name'
type: integer
format: int64
photoUrls:
title: 'Photo urls'
description: 'Photo urls'
type: array
items:
type: string
default: images/image-1.png
xml:
name: photoUrl
wrapped: true
tags:
title: 'Pet tags'
description: 'Pet tags'
type: array
items:
$ref: '#/components/schemas/Tag'
xml:
name: tag
wrapped: true
type: object
xml:
name: Pet
Tag:
title: Tag
description: Tag.
properties:
id:
title: ID
description: ID
type: integer
format: int64
name:
title: Name
description: Name
type: string
type: object
xml:
name: Tag
User:
title: 'User model'
description: 'User model'
properties:
id:
title: ID
description: ID
type: integer
format: int64
username:
title: Username
description: Username
type: string
firstName:
title: 'First name'
description: 'First name'
type: string
lastName:
title: 'Last name'
description: 'Last name'
type: string
email:
title: Email
description: Email
type: string
format: email
password:
title: Password
description: Password
type: string
format: int64
maximum: 255
phone:
title: Phone
description: Phone
type: string
format: msisdn
userStatus:
title: 'User status'
description: 'User status'
type: integer
format: int32
type: object
requestBodies:
Pet:
description: 'Pet object that needs to be added to the store'
required: true
content:
application/xml:
schema:
$ref: '#/components/schemas/Pet'
application/json:
schema:
$ref: '#/components/schemas/Pet'
UserArray:
description: 'List of user object'
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
securitySchemes:
petstore_auth:
type: oauth2
flows:
implicit:
authorizationUrl: 'http://petstore.swagger.io/oauth/dialog'
scopes:
'write:pets': 'modify pets in your account'
'read:pets': 'read your pets'
api_key:
type: apiKey
name: api_key
in: header
tags:
-
name: pet
description: 'Everything about your Pets'
externalDocs:
description: 'Find out more'
url: 'http://swagger.io'
-
name: store
description: 'Access to Petstore orders'
-
name: user
description: 'Operations about user'
externalDocs:
description: 'Find out more about store'
url: 'http://swagger.io'
externalDocs:
description: 'Find out more about Swagger'
url: 'http://swagger.io'