-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
1333 lines (1316 loc) · 33.9 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
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
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
version: 1.0.0
title: Auction API
description: API
schemes:
- "http"
host: "localhost:8080"
basePath: "/"
security:
- JWT: []
consumes:
- application/json
produces:
- application/json
tags:
- name: auth
- name: groups
- name: users
- name: lots
- name: service
paths:
/login:
post:
summary: /login
tags:
- auth
security: []
consumes:
- application/x-www-form-urlencoded
parameters:
- in: formData
name: username
type: string
required: true
- in: formData
name: password
type: string
required: true
responses:
200:
description: OK
schema:
type: object
properties:
token:
type: string
/groups:
get:
summary: /groups
description: Получить список групп.
tags:
- groups
responses:
200:
description: Группы лотов
schema:
type: array
items:
$ref: '#/definitions/Group'
post:
summary: /groups
tags:
- groups
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Group'
responses:
201:
description: Группа
schema:
$ref: '#/definitions/Group'
/users:
get:
summary: /users
tags:
- users
responses:
200:
description: Список пользователей
schema:
type: array
items:
$ref: '#/definitions/User'
post:
summary: /users
tags:
- users
parameters:
- in: body
name: body
required: true
schema:
allOf:
- $ref: '#/definitions/User'
- type: object
properties:
password:
type: string
format: password
required:
- password
responses:
201:
description: Пользователь
schema:
$ref: '#/definitions/User'
patch:
summary: /users
tags:
- users
parameters:
- in: body
name: body
required: true
schema:
allOf:
- $ref: '#/definitions/UserInfo'
- type: object
responses:
201:
description: Пользователь
schema:
$ref: '#/definitions/User'
/users/{userID}:
parameters:
- $ref: '#/parameters/UserID'
get:
summary: /users/:id
tags:
- users
responses:
200:
$ref: '#/responses/User'
404:
$ref: '#/responses/UserNotFound'
/users/{userID}/goups/{groupKey}:
parameters:
- $ref: '#/parameters/UserID'
- in: path
name: groupKey
description: Ключ группы
type: string
required: true
put:
summary: /users/{userID}/goups/{groupKey}
tags:
- users
responses:
204:
$ref: '#/responses/NoContent'
delete:
summary: /users/{userID}/goups/{groupKey}
description: Удалить группу у пользователя
tags:
- users
responses:
204:
$ref: '#/responses/NoContent'
/user/{userID}/block:
patch:
summary: '/user/{userID}/block'
tags:
- user
responses:
'204':
$ref: '#/responses/NoContent'
'404':
$ref: '#/responses/UserNotFound'
parameters:
- $ref: '#/parameters/UserID'
- in: path
name: userID
type: integer
required: true
/user/{userID}/unblock:
patch:
summary: '/user/{userID}/unblock'
tags:
- user
responses:
'204':
$ref: '#/responses/NoContent'
'404':
$ref: '#/responses/UserNotFound'
parameters:
- $ref: '#/parameters/UserID'
- in: path
name: userID
type: integer
required: true
/lots:
get:
summary: /lots
tags:
- lots
parameters:
- in: query
name: group_key
description: Группа объектов
required: true
type: string
- in: query
name: state
description: |
Состояние лота:
* all - Все
* active - Активные
* booked - Забронированые
* completed - Завершенные
* no_completed - Не завершенные
type: string
- in: query
name: lot_id
description: ID лота.
type: integer
format: uint32
- in: query
name: object_id
description: ID объекта лота.
type: integer
format: uint32
- in: query
name: start_price
description: Нижняя граница стоимости лота.
type: integer
format: uint32
- in: query
name: end_price
description: Верхняя граница стоимости лота.
type: integer
format: uint32
# Фильтры для лотов с объектом типа 'trip'
- in: query
name: city_from
description: |
Первый город погрузки. Действует для лота с объектом типа 'trip'.
type: string
- in: query
name: city_to
description: |
Последний город разгрузки. Действует для лота с объектом типа 'trip'.
type: string
- in: query
name: from_start_date
description: |
Начало периода для даты погрузки. Действует для лота с объектом типа 'trip'.
type: string
format: date-time
- in: query
name: from_end_date
description: |
Конец периода для даты погрузки. Действует для лота с объектом типа 'trip'.
type: string
format: date-time
- in: query
name: to_start_date
description: |
Начало периода для даты разгрузки. Действует для лота с объектом типа 'trip'.
type: string
format: date-time
- in: query
name: ещ_end_date
description: |
Конец периода для даты разгрузки. Действует для лота с объектом типа 'trip'.
type: string
format: date-time
- in: query
name: start_tonnage
description: |
Нижняя граница тоннажа. Действует для лота с объектом типа 'trip'.
type: integer
format: uint32
- in: query
name: end_tonnage
description: |
Верхняя граница тоннажа. Действует для лота с объектом типа 'trip'.
type: integer
format: uint32
responses:
200:
description: Список лотов
schema:
type: array
items:
$ref: '#/definitions/Lot'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.get.lots",
"payload": {
"group_key": "group_key",
"state": "state",
"object_id": 0,
"start_price": 0,
"end_price": 0,
"city_from": "city_from",
"city_to": "city_to",
"start_date": "2018-05-20T20:09:27Z",
"end_date": "2018-05-25T20:09:27Z",
"start_tonnage": 0,
"end_tonnage": 0
}
}
post:
summary: /lots
tags:
- lots
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Lot'
responses:
201:
$ref: '#/responses/Lot'
/lots/{lotID}:
parameters:
- $ref: '#/parameters/LotID'
get:
summary: /lots/:id
tags:
- lots
responses:
200:
$ref: '#/responses/Lot'
404:
$ref: '#/responses/LotNotFound'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.get.lot",
"payload": {
"lot_id": 0
}
}
patch:
summary: /lots/:id
tags:
- lots
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Lot'
responses:
200:
$ref: '#/responses/Lot'
404:
$ref: '#/responses/LotNotFound'
delete:
summary: /lots/:id
tags:
- lots
responses:
204:
$ref: '#/responses/NoContent'
404:
$ref: '#/responses/LotNotFound'
/lots/{lotID}/bet:
parameters:
- $ref: '#/parameters/LotID'
post:
summary: /lots/:id/bet
tags:
- lots
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Bet'
responses:
204:
$ref: '#/responses/NoContent'
404:
$ref: '#/responses/LotNotFound'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.place.bet",
"payload": {
"lot_id": 0,
"value": 0
}
}
delete:
summary: /lots/:id/bet
tags:
- lots
responses:
204:
$ref: '#/responses/NoContent'
404:
$ref: '#/responses/LotNotFound'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.cancel.bet",
"payload": {
"lot_id": 0
}
}
/lots/{lotID}/confirm:
parameters:
- $ref: '#/parameters/LotID'
put:
summary: /lots/:id/confirm
tags:
- lots
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Confirm'
responses:
404:
$ref: '#/responses/LotNotFound'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.confirm.lot",
"payload": {
"lot_id": 0,
"info": {
"surname": "surname",
"name": "name",
"patronymic": "patronymic",
"truck_number": "truck_number",
"trailer_number": "trailer_number",
"phone_number": "phone_number",
"date_arrival": "date_arrival"
}
}
}
patch:
summary: /lots/:id/confirm
tags:
- lots
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Confirm'
responses:
404:
$ref: '#/responses/LotNotFound'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.edit.confirmation",
"payload": {
"lot_id": 0,
"info": {
"surname": "surname",
"name": "name",
"patronymic": "patronymic",
"truck_number": "truck_number",
"trailer_number": "trailer_number",
"phone_number": "phone_number",
"date_arrival": "date_arrival"
}
}
}
delete:
summary: /lots/:id/confirm
tags:
- lots
responses:
204:
$ref: '#/responses/NoContent'
404:
$ref: '#/responses/LotNotFound'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.delete.confirmation",
"payload": {
"lot_id": 0
}
}
/lots/{lotID}/complete:
parameters:
- $ref: '#/parameters/LotID'
put:
summary: /lots/:id/complete
tags:
- lots
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/Complete'
responses:
404:
$ref: '#/responses/LotNotFound'
x-code-samples:
- lang: WebSocket Command
source: |
{
"type": "command.complete.lot",
"payload": {
"lot_id": 0,
"info": {
"act_number" :"act_number",
"act_date" :"act_date",
"send_date" :"send_date",
"receive_date" :"receive_date",
"receive_repeat_date" :"receive_repeat_date",
"registry_date" :"registry_date",
"payment_date" :"payment_date",
"rise_in_price" :"rise_in_price",
"comment" :"comment"
}
}
}
/lots/{lotID}/reservation:
parameters:
- $ref: '#/parameters/LotID'
post:
summary: /lots/:id/reservation
tags:
- lots
responses:
204:
$ref: '#/responses/NoContent'
404:
$ref: '#/responses/LotNotFound'
delete:
summary: /lots/:id/reservation
tags:
- lots
responses:
204:
$ref: '#/responses/NoContent'
404:
$ref: '#/responses/LotNotFound'
/lots/{lotID}/history:
parameters:
- $ref: '#/parameters/LotID'
get:
summary: /lots/{lotID}/history
tags:
- lots
responses:
200:
description: Список лотов
schema:
type: array
items:
$ref: '#/definitions/History'
/lots/{lotID}/act:
parameters:
- $ref: '#/parameters/LotID'
get:
summary: /lots/:id/act
tags:
- lots
responses:
200:
$ref: '#/definitions/GetActStructure'
400:
$ref: '#/definitions/MissingLotID'
404:
$ref: '#/responses/LotNotFound'
patch:
summary: /lots/{lotID}/act
tags:
- lots
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/ChangeActStructure'
responses:
204:
$ref: '#/responses/NoContent'
400:
$ref: '#/responses/UpdateAct400Errors'
404:
$ref: '#/responses/LotNotFound'
/lots/{lotID}/act_allow_change:
parameters:
- $ref: '#/parameters/LotID'
post:
summary: /lots/{lotID}/act_allow_change
description: Открытие доступа на редактирование акта
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/AllowChangeStructure'
tags:
- lot
responses:
204:
$ref: '#/responses/NoContent'
400:
$ref: '#/responses/AllowActChanging400Errors'
404:
$ref: '#/responses/LotNotFound'
/lots/{lotID}/bets/{betID}/accept:
parameters:
- $ref: '#/parameters/LotID'
- $ref: '#/parameters/BetID'
put:
summary: /lots/{lotID}/bets/{betID}/accept
description: Закрепление указанной ставки за лотом
tags:
- lots
responses:
204:
$ref: '#/responses/NoContent'
/feedback:
post:
summary: /feedback
description: Отправка обратной связи
tags:
- service
parameters:
- in: body
name: body
required: true
schema:
type: object
properties:
message:
type: string
description: Сообщение (с поддержкой markdown)
responses:
204:
$ref: '#/responses/NoContent'
parameters:
UserID:
in: path
name: userID
description: Идентификатор пользователя
type: integer
format: int32
required: true
LotID:
in: path
name: lotID
description: Идентификатор лота
type: integer
format: int32
required: true
BetID:
in: path
name: betID
description: Идентификатор ставки
type: integer
format: int32
required: true
responses:
NoContent:
description: No content
User:
description: Лот
schema:
$ref: '#/definitions/User'
Lot:
description: Лот
schema:
$ref: '#/definitions/Lot'
Bet:
description: Ставка
schema:
$ref: '#/definitions/Bet'
UserNotFound:
description: Пользователь не найден
schema:
$ref: '#/definitions/Error'
LotNotFound:
description: Лот не найден
schema:
$ref: '#/definitions/Error'
UpdateAct400Errors:
description: |
* Не передали doc_number
* Не передали date
* Пропущен параметр LotID
* Не прошла валидация параметра date
* Если allow_change у лота в значении 0, придет ошибка о том, что вы не можете вторично изменять акт
* Любая ошибка из проекта менеджера
schema:
$ref: '#/definitions/Error'
AllowActChanging400Errors:
schema:
$ref: '#/definitions/Error'
description: |
* Не передан LotID
definitions:
UserInfo:
type: object
properties:
employer_name:
type: string
employer_surname:
type: string
employer_patronymic:
type: string
company_name:
type: string
phone_number:
type: string
User:
allOf:
- $ref: '#/definitions/UserInfo'
- type: object
properties:
id:
type: integer
format: uint32
readOnly: true
username:
type: string
object_type:
$ref: '#/definitions/ObjectType'
back_key:
description: Ключ для обращение к сервису
type: string
employer_name:
type: string
employer_surname:
type: string
employer_patronymic:
type: string
company_name:
type: string
phone_number:
type: string
required:
- username
- object_type
Group:
type: object
properties:
key:
description: Ключ группы
type: string
name:
description: Название группы
type: string
object_type:
description: Тип объекта
type: string
required:
- key
- name
- object_type
example:
key: nc_trip
name: Рейсы НК
object_type: trip
Rule:
description: Конфигурация правил
type: object
properties:
type:
description: |
Типы правил
* normal - Правила обычного аукциона
* extra - Правила экстра аукциона
* pick - Правила забрать по базе
type: string
enum:
- normal
- extra
- pick
start:
type: string
end:
type: string
readOnly: true
duration:
description: |
Продолжительность правил (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
required:
- type
- start
- duration
discriminator: type
example:
type: normal
start: '15:00:00'
duration: '1h'
RuleNormal:
description: Конфигурация правил для обычного аукциона
allOf:
- $ref: '#/definitions/Rule'
- type: object
properties:
base_price:
description: Базовая цена лота
type: integer
format: uint32
minimum: 0
exclusiveMinimum: true
bet_step:
description: Шаг изменения лота
type: integer
format: uint32
minimum: 0
last_moment:
description: |
Остаток времени до конца интервала, для продления торгов (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
default: '15m'
prolong_duration:
description: |
Продолжительность продления правила (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
default: '15m'
max_duration:
description: |
Максимальная продолжительность торгов с у четом продления (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
default: '3h'
confirm_duration:
description: |
Продолжительность подтверждения лота (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
default: '1h'
required:
- base_price
RuleExtra:
description: Конфигурация правил для экстра аукциона
allOf:
- $ref: '#/definitions/Rule'
- type: object
properties:
extra_price:
type: integer
format: uint32
minimum: 0
exclusiveMinimum: true
bet_step:
type: integer
format: uint32
minimum: 0
hot_duration:
description: |
Продолжительность торгов с участием трех пользователей (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
default: '30m'
confirm_duration:
description: |
Продолжительность подтверждения лота (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
default: '1h'
required:
- extra_price
RulePick:
description: Конфигурация правил забрать по базе
allOf:
- $ref: '#/definitions/Rule'
- type: object
properties:
base_price:
description: Базовая цена лота
type: integer
format: uint32
minimum: 0
exclusiveMinimum: true
confirm_duration:
description: |
Продолжительность подтверждения лота (
https://golang.org/pkg/time/#ParseDuration -
описание возможных вариантов значений)
type: string
format: duration
default: '1h'
required:
- base_price
Lot:
type: object
properties:
id:
type: integer
format: uint32
readOnly: true
rules:
description: Набор правил
type: array
items:
$ref: '#/definitions/Rule'
minItems: 1
created_at:
type: string
format: date-time
readOnly: true
updated_at:
type: string
format: date-time
readOnly: true
booked_at:
description: Необходимо передавать для ручного бронирования лота
type: string
format: date-time
confirmed_at:
type: string
format: date-time
readOnly: true
completed_at:
type: string
format: date-time
readOnly: true
object_id:
type: integer
format: uint32
object:
$ref: '#/definitions/Object'
group_key:
type: string
bet:
description: Необходимо передавать для ручного бронирования лота
$ref: '#/definitions/Bet'
bet_step:
type: integer
format: uint32
minimum: 0
current_price:
description: Текущая ставка
type: integer
format: uint32
readOnly: true
user_price:
description: Последняя ставка пользователя
type: integer
format: uint32
readOnly: true
rule:
description: |
Текущее активное правило, возможные значения
* pick - Забрать по базе
* normal - Обычного аукциона
* extra - Экстра аукциона
* hot - Тридцати минутная гонка
* confirm - Ожидание подтверждения
* wait - Ожидание активации правил
type: string
enum:
- pick