/
swagger.yaml
309 lines (280 loc) · 6.85 KB
/
swagger.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
swagger: '2.0'
info:
description: This is a simplified version of the sample server Petstore server.
version: 1.0.0
title: Swagger Simple Petstore
schemes: [http]
host: localhost:5000
basePath: /api
consumes: [application/json]
produces: [application/json]
tags:
- name: pet
description: Everything about your Pets
- name: store
description: Access to Petstore orders
securityDefinitions:
token:
type: apiKey
in: header
name: Cookie
security:
- token: []
paths:
/pets:
post:
tags: [pet]
summary: Add a new pet to the store
operationId: PetCreate
parameters:
- in: body
name: pet
description: Pet object that needs to be added to the store
required: true
schema:
$ref: '#/definitions/Pet'
responses:
201:
description: Created
schema:
$ref: '#/definitions/Pet'
405:
description: Invalid input
security:
- token: [admin]
get:
tags: [pet]
summary: List pets
operationId: PetList
parameters:
- name: status
in: query
description: Status values that need to be considered for filter
required: true
type: array
items:
type: string
enum:
- available
- pending
- sold
default: available
collectionFormat: multi
responses:
200:
description: successful operation
schema:
type: array
items:
$ref: '#/definitions/Pet'
400:
description: Invalid status value
/pets/{petId}:
put:
tags: [pet]
summary: Update an existing pet
operationId: PetUpdate
parameters:
- name: petId
in: path
description: ID of pet to return
required: true
type: integer
format: int64
- in: body
name: pet
description: Pet object that needs to be added to the store
required: true
schema:
$ref: '#/definitions/Pet'
responses:
201:
description: Updated successfully
schema:
$ref: '#/definitions/Pet'
400:
description: Invalid ID supplied
404:
description: Pet not found
405:
description: Validation exception
security:
- token: [admin]
get:
tags: [pet]
summary: Get pet by it's ID
operationId: PetGet
parameters:
- name: petId
in: path
description: ID of pet to return
required: true
type: integer
format: int64
responses:
200:
description: successful operation
schema:
$ref: '#/definitions/Pet'
400:
description: Invalid ID supplied
404:
description: Pet not found
delete:
tags: [pet]
summary: Deletes a pet
description: ''
operationId: PetDelete
parameters:
- name: api_key
in: header
required: false
type: string
- name: petId
in: path
description: Pet id to delete
required: true
type: integer
format: int64
responses:
204:
description: Deleted successfully
400:
description: Invalid ID supplied
404:
description: Pet not found
security:
- token: [admin]
/store/inventory:
get:
tags: [store]
summary: Returns pet inventories by status
operationId: InventoryGet
responses:
200:
description: successful operation
schema:
type: object
additionalProperties:
type: integer
format: int32
/store/order:
post:
tags: [store]
summary: Place an order for a pet
operationId: OrderCreate
parameters:
- in: body
name: order
description: order placed for purchasing the pet
required: true
schema:
$ref: '#/definitions/Order'
responses:
200:
description: successful operation
schema:
$ref: '#/definitions/Order'
400:
description: Invalid Order
/store/order/{orderId}:
get:
tags: [store]
summary: Find purchase order by ID
description: For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions
operationId: OrderGet
parameters:
- name: orderId
in: path
description: ID of pet that needs to be fetched
required: true
type: integer
maximum: 10
minimum: 1
format: int64
responses:
200:
description: successful operation
schema:
$ref: '#/definitions/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: OrderDelete
parameters:
- name: orderId
in: path
description: ID of the order that needs to be deleted
required: true
type: integer
minimum: 1
format: int64
responses:
204:
description: Deleted successfully
400:
description: Invalid ID supplied
404:
description: Order not found
definitions:
Pet:
type: object
required:
- name
properties:
id:
type: integer
format: int64
x-go-custom-tag: gorm:"primary_key" query:"filter,sort"
category:
$ref: '#/definitions/Category'
name:
type: string
example: doggie
x-go-custom-tag: query:"filter,sort"
status:
type: string
description: pet status in the store
enum:
- available
- pending
- sold
x-go-custom-tag: query:"filter,sort"
Category:
type: object
properties:
id:
type: integer
format: int64
name:
type: string
Order:
type: object
properties:
id:
type: integer
format: int64
petId:
type: integer
format: int64
quantity:
type: integer
format: int32
shipDate:
type: string
format: date-time
status:
type: string
description: Order Status
enum:
- placed
- approved
- delivered
complete:
type: boolean
default: false