-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger_api.yml
510 lines (508 loc) · 13.3 KB
/
swagger_api.yml
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
openapi: 3.0.0
info:
description: |
This is a simple web auction
version: "1.0.0"
title: Web auction
servers:
- description: Localhost docker ip
url: http://192.168.99.100:8000
paths:
/items:
post:
tags:
- item
summary: Add a new item
responses:
'200':
description: Item was created
requestBody:
$ref: '#/components/requestBodies/Item'
get:
tags:
- item
summary: Get list of items
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ItemsList'
parameters:
- name: page
in: query
description: page number, starts at 0
schema:
type: integer
format: int64
- name: sort
in: query
description: sorting field
schema:
type: string
enum:
- create_dt
- price
- name: order
in: query
description: sorting direction
schema:
type: string
enum:
- asc
- desc
- name: search_string
in: query
description: full text search
schema:
type: string
- name: show_closed
in: query
description: true - show closed items. false - hide
schema:
type: boolean
default: true
- name: page_size
in: query
description: Items count on 1 page. -1 - all items
schema:
type: integer
format: int64
'/items/{itemId}':
get:
tags:
- item
summary: Read an existing item
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRead'
parameters:
- name: itemId
in: path
description: ID of item that needs to be readed
required: true
schema:
type: integer
format: int64
put:
tags:
- item
summary: Update an existing item
responses:
'200':
description: Item was updated
parameters:
- name: itemId
in: path
description: ID of item that needs to be updated
required: true
schema:
type: integer
format: int64
requestBody:
$ref: '#/components/requestBodies/Item'
'/items/{itemId}/bids':
get:
tags:
- item
summary: Get item bid history
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Bid'
parameters:
- name: itemId
in: path
description: ID of item
required: true
schema:
type: integer
format: int64
'/items/{itemId}/auto_bid':
post:
tags:
- item
summary: Enable/disable autobid
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
result:
type: boolean
example: true
description: true - successful operation, false - error
auto_bid_state:
type: boolean
example: true
description: true - autobid enabled, false - autobid disabled
parameters:
- name: itemId
in: path
description: ID of item
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
type: object
required:
- user_id
- auto_bid
properties:
user_id:
type: integer
format: int64
example: 21
description: User ID
auto_bid:
type: boolean
example: true
description: true - enable, false - disable autobid
'/users/{userId}':
get:
tags:
- user
summary: Read an existing user
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/User'
parameters:
- name: userId
in: path
description: User ID
required: true
schema:
type: integer
format: int64
put:
tags:
- user
summary: Update an existing user
responses:
'200':
description: Item was updated
content:
application/json:
schema:
type: object
properties:
result:
type: boolean
example: true
description: successful operation
parameters:
- name: userId
in: path
description: User ID
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserBase'
'/users/{userId}/item/{itemId}':
get:
tags:
- user
summary: Read item user info (autobid status)
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
autobid:
type: boolean
example: true
description: autobid is enabled or not
parameters:
- name: userId
in: path
description: User ID
required: true
schema:
type: integer
format: int64
- name: itemId
in: path
description: Item ID
required: true
schema:
type: integer
format: int64
'/users/bids':
get:
tags:
- user
summary: Get bids of user
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserItemBid'
parameters:
- name: sort
in: query
description: sorting. 'bid_dt' - by bid creation date, 'close_dt' - by item closing date
schema:
type: string
enum:
- bid_dt
- close_dt
- name: user
in: query
description: User login
schema:
type: string
- name: status
in: query
description: Status of item's bid
schema:
type: string
enum:
- won
/sign_in:
post:
tags:
- sign_in
summary: Sign in
responses:
'200':
description: successful operation
content:
application/json:
schema:
type: object
properties:
result:
type: boolean
description: Successful login
example: true
id:
type: integer
format: int64
description: User ID
example: 23
login:
type: string
description: User login
example: some_login
role:
type: string
description: User role
example: admin
requestBody:
content:
application/json:
schema:
type: object
properties:
login:
type: string
description: User login
example: some_login
password:
type: string
description: User password
example: some_password
components:
schemas:
Bid:
type: object
properties:
id:
type: integer
format: int64
example: 24
description: Bid ID
user_name:
type: string
example: Adam Gosling
price:
type: integer
format: int64
example: 98
description: Bid price
bid_dt:
type: integer
format: int64
example: 1595706314
description: Epoch time of bid
UserBase:
type: object
properties:
email:
type: string
example: [email protected]
description: User email
autobid_total_sum:
type: integer
format: int64
example: 3000
description: Money ($) for autobiding
autobid_alert_perc:
type: integer
format: int64
example: 75
description: Percent of alert notification
User:
allOf:
- $ref: '#/components/schemas/UserBase'
- type: object
properties:
id:
type: integer
format: int64
example: 23
description: User ID
name:
type: string
example: Adam Gosling
description: User name/login
UserItemBid:
type: object
properties:
item_id:
type: integer
format: int64
example: 33
description: Item ID
item:
type: string
example: Harry Potter
status:
type: string
enum:
- won
- lost
- in_progress
example: won
user_price:
type: integer
format: int64
example: 99
description: Current user bid
max_price:
type: integer
format: int64
example: 100
description: Current max item bid
dt:
type: integer
format: int64
example: 1595701314
description: Epoch time of bid creation
close_dt:
type: integer
format: int64
example: 1595702314
description: Epoch time of item auction closing
Item:
type: object
required:
- title
- price
- close_dt
properties:
title:
type: string
example: Harry Potter
description:
type: string
example: Children's book
price:
type: integer
format: int64
example: 99
description: Item current price
close_dt:
type: integer
format: int64
example: 1595702314
description: epoch time
ItemRead:
allOf:
- $ref: '#/components/schemas/Item'
- type: object
properties:
id:
type: integer
format: int64
example: 23
description: Item ID
awarded_user:
type: string
example: Adam Gosling
description: Item awarder user name
create_dt:
type: integer
format: int64
example: 1595702214
description: Epoch time of item creation
expired:
type: boolean
description: Item is closed
ItemsList:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/ItemOfList'
description: List of items
total_count:
type: integer
format: int64
example: 7
description: Total items count
ItemOfList:
allOf:
- $ref: '#/components/schemas/Item'
- type: object
properties:
id:
type: integer
format: int64
example: 23
description: Item ID
create_dt:
type: integer
format: int64
example: 1595702214
description: Epoch time of item creation
requestBodies:
Item:
content:
application/json:
schema:
$ref: '#/components/schemas/Item'