generated from yandex-praktikum/java-shareit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathshareit-open-api-spec.yaml
1429 lines (1423 loc) · 52.6 KB
/
shareit-open-api-spec.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
openapi: 3.0.1
info:
title: '"ShareIt" API'
description: 'RESTful platform for item exchange: find, share, rent'
contact:
name: Ivan Marakanov (BucketOnHead)
url: https://github.com/BucketOnHead
email: marakanovivan@gmail.com
version: '1.0'
servers:
- url: http://localhost:8080
description: Generated server url
tags:
- name: Пользователи
description: API для работы с пользователями
- name: Бронирование
description: API для работы с бронированием
- name: Запрос вещи
description: API для работы с запросами вещей
- name: Вещи
description: API для работы с вещами
paths:
/users:
get:
tags:
- Пользователи
summary: Получение информации о пользователях
description: |-
Возвращает информацию обо всех пользователях
В случае, если не найдено ни одного пользователя, возвращает пустой список
operationId: getUsers
parameters:
- name: from
in: query
description: Количество элементов, которые нужно пропустить для формирования текущего набора
required: false
schema:
minimum: 0
type: integer
format: int32
default: 0
example: 10
- name: size
in: query
description: Количество элементов в наборе
required: false
schema:
type: integer
format: int32
default: 10
example: 20
responses:
'200':
description: Пользователи найдены
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: BAD_REQUEST
reason: Bad Request
message: Parameter(s) failed validation
errors:
- parameter 'size' must be greater than 0, but it was '0'
- parameter 'from' must be greater than or equal to 0, but it was '-1'
timestamp: '2023-10-17T16:59:11.237789'
post:
tags:
- Пользователи
summary: Добавление нового пользователя
operationId: addUser
requestBody:
description: Данные добавляемого пользователя
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreationDto'
required: true
responses:
'200':
description: Пользователь добавлен
content:
application/json:
schema:
$ref: '#/components/schemas/UserDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: BAD_REQUEST
reason: Bad Request
message: Field(s) failed validation
errors:
- field 'email' must have the format of an email address, but it was 'vasyaexample.com'
timestamp: '2023-10-17T19:12:12.08784'
'409':
description: Конфликт с базой данных
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: CONFLICT
reason: Request conflicts with another request or with server configuration
message: User email must be unique
timestamp: '2023-10-17T19:27:41.322698'
/requests:
get:
tags:
- Запрос вещи
summary: Получение списка запросов вещей от пользователя
description: |-
Получение всех запросов пользователя вместе с данными об ответах на них
В случае, если запросы не найден возвращает пустой список
operationId: getItemRequestsByRequesterId
parameters:
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Запросы вещей от пользователя найдены
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemRequestDto'
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
post:
tags:
- Запрос вещи
summary: Добавление запроса вещи от пользователя
description: Основная часть запроса - описание, в котором пользователь описывает, какая вещь ему нужна
operationId: addItemRequest
parameters:
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
requestBody:
description: Данные запроса вещи
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRequestCreationDto'
required: true
responses:
'200':
description: Запрос на вещь добавлен
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRequestDto'
example:
id: 1
description: Хотел бы воспользоваться щёткой для обуви
created: '2023-10-18T14:49:08.869138'
items: null
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: BAD_REQUEST
reason: Bad Request
message: Field(s) failed validation
errors:
- field 'description' should not be empty, but it was 'null'
timestamp: '2023-10-18T14:42:50.201833'
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
/items:
get:
tags:
- Вещи
summary: Получение информации о вещах пользователя
description: Получение всех вещей пользователя вместе с информацией о последнем и следующем бронированиях
operationId: getItemsByUserId
parameters:
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
- name: from
in: query
description: Количество элементов, которые нужно пропустить для формирования текущего набора
required: false
schema:
minimum: 0
type: integer
format: int32
default: 0
example: 10
- name: size
in: query
description: Количество элементов в наборе
required: false
schema:
type: integer
format: int32
default: 10
example: 20
responses:
'200':
description: Вещи пользователя найдены
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ItemDetailsDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: BAD_REQUEST
reason: Bad Request
message: Parameter(s) failed validation
errors:
- parameter 'size' must be greater than 0, but it was '0'
- parameter 'from' must be greater than or equal to 0, but it was '-1'
timestamp: '2023-10-17T16:59:11.237789'
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
post:
tags:
- Вещи
summary: Добавление новой вещи
description: Добавление новой вещи, владельцем которой будет пользовать с идентификатором из заголовка
operationId: addItem
parameters:
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
requestBody:
description: Данные новой вещи
content:
application/json:
schema:
$ref: '#/components/schemas/ItemCreationDto'
required: true
responses:
'200':
description: Вещь добавлена
content:
application/json:
schema:
$ref: '#/components/schemas/ItemDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: BAD_REQUEST
reason: Bad Request
message: Field(s) failed validation
errors:
- field 'description' should not be empty, but it was 'null'
timestamp: '2023-10-18T14:42:50.201833'
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
/items/{itemId}/comment:
post:
tags:
- Вещи
summary: Добавление комментария (отзыва) к вещи
description: После того, как бронирование вещи завершено, пользователь может оставить комментарий (отзыв) к ней
operationId: addComment
parameters:
- name: itemId
in: path
description: Идентификатор вещи
required: true
schema:
type: integer
format: int64
example: 4
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
requestBody:
description: Данные комментария (отзыва)
content:
application/json:
schema:
$ref: '#/components/schemas/CommentCreationDto'
required: true
responses:
'200':
description: Комментарий добавлен
content:
application/json:
schema:
$ref: '#/components/schemas/CommentDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Нельзя оставить комментарий:
description: Не найдено подтвержденного бронирования или оно ещё не завершено
value:
status: BAD_REQUEST
reason: Request cannot be understood by the server due to incorrect syntax
message: 'Unable to leave comment for item with id: 1: no approved booking for user with id: 4 or booking is not yet finished'
timestamp: '2023-10-19T09:57:46.77556'
Ошибка валидации:
description: Ошибка валидации
value:
status: BAD_REQUEST
reason: Bad Request
message: Field(s) failed validation
errors:
- field 'description' should not be empty, but it was 'null'
timestamp: '2023-10-18T14:42:50.201833'
'404':
description: Необходимые ресурсы не найдены
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Пользователь не найден:
description: Пользователь не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
Вещь не найдена:
description: Вещь не найдена
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'Item not found with id: 99'
timestamp: '2023-10-19T10:11:42.797793'
/bookings:
get:
tags:
- Бронирование
summary: Получение всех бронирований от пользователя
operationId: getBookingsByBookerId
parameters:
- name: state
in: query
description: Состояние бронирования
required: false
schema:
$ref: '#/components/schemas/BookingState'
- name: from
in: query
description: Количество элементов, которые нужно пропустить для формирования текущего набора
required: false
schema:
minimum: 0
type: integer
format: int32
default: 0
example: 10
- name: size
in: query
description: Количество элементов в наборе
required: false
schema:
type: integer
format: int32
default: 10
example: 20
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Бронирования найдены
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BookingDto'
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/BookingDto'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
post:
tags:
- Бронирование
summary: Добавление бронирования
description: |-
Добавляет новое бронирование, при условии, что вещь доступна.
Запрещается бронировать свою же вещь
operationId: addBooking
parameters:
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
requestBody:
description: Информация о бронировании
content:
application/json:
schema:
$ref: '#/components/schemas/BookingCreationDto'
required: true
responses:
'200':
description: Бронирование добавлено
content:
application/json:
schema:
$ref: '#/components/schemas/BookingDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Вещь не готова к бронированию:
description: Вещь не готова к бронированию
value:
status: BAD_REQUEST
reason: Request cannot be understood by the server due to incorrect syntax
message: 'Item with id: 2 not available for booking'
timestamp: '2023-10-19T14:29:43.586513'
Некорректный запрос:
description: Некорректный запрос
value:
status: BAD_REQUEST
reason: Bad Request
message: Field(s) failed validation
errors:
- field 'end' не должно равняться null, but it was 'null'
- field 'start' не должно равняться null, but it was 'null'
timestamp: '2023-10-19T14:32:41.237296'
'404':
description: Необходимые ресурсы не найдены или нарушена логика
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Пользователь бронирует свою же вещь:
description: Пользователь бронирует свою же вещь
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 cannot book their item with id: 1'
timestamp: '2023-10-19T14:26:41.520621'
Запрос не найден:
description: Запрос не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'Item request with id: 99 not found'
timestamp: '2023-10-18T15:20:42.426754'
Пользователь не найден:
description: Пользователь не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
/users/{userId}:
get:
tags:
- Пользователи
summary: Получение информации о пользователе по идентификатору
description: В случае, если пользователь не найден возвращает код 404
operationId: getUserById
parameters:
- name: userId
in: path
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Пользователь найден
content:
application/json:
schema:
$ref: '#/components/schemas/UserDto'
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
delete:
tags:
- Пользователи
summary: Удаление пользователя по идентификатору
operationId: deleteUserById
parameters:
- name: userId
in: path
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Пользователь удалён
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
patch:
tags:
- Пользователи
summary: Обновить данные пользователя
description: Для обновления пользователя используется тоже дто, что и для создания, все параметры НЕОБЯЗАТЕЛЬНЫ, email при указании должен быть правильного формата
operationId: updateUser
parameters:
- name: userId
in: path
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
requestBody:
description: Данные для обновления пользователя
content:
application/json:
schema:
$ref: '#/components/schemas/UserCreationDto'
required: true
responses:
'200':
description: Пользователь обновлен
content:
application/json:
schema:
$ref: '#/components/schemas/UserDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: BAD_REQUEST
reason: Bad Request
message: Field(s) failed validation
errors:
- field 'email' must have the format of an email address, but it was 'vasyaexample.com'
timestamp: '2023-10-17T19:12:12.08784'
'404':
description: Пользователь не найден
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
/items/{itemId}:
get:
tags:
- Вещи
summary: Получение информации о вещи
description: |-
Получение информации о вещи вместе с комментариями
Если пользователь является владельцем этой вещи, то к данным добавляется информация о предыдущем и следующем бронированиях
operationId: getItemById
parameters:
- name: itemId
in: path
description: Идентификатор вещи
required: true
schema:
type: integer
format: int64
example: 4
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Вещь найдена
content:
application/json:
schema:
$ref: '#/components/schemas/ItemDetailsDto'
'404':
description: Вещь не найдена
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'Item not found with id: 99'
timestamp: '2023-10-19T10:11:42.797793'
patch:
tags:
- Вещи
summary: Обновление вещи
description: |-
Для обновления вещи используется тоже дто, что и для создания, все параметры НЕ ОБЯЗАТЕЛЬНЫ
Обновить вещь может только ее владелец
operationId: updateItem
parameters:
- name: itemId
in: path
description: Идентификатор вещи
required: true
schema:
type: integer
format: int64
example: 4
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
requestBody:
description: Данные для обновление
content:
application/json:
schema:
$ref: '#/components/schemas/ItemCreationDto'
required: true
responses:
'200':
description: Вещь обновлена
content:
application/json:
schema:
$ref: '#/components/schemas/ItemDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: BAD_REQUEST
reason: Bad Request
message: Parameter(s) failed validation
errors:
- parameter 'size' must be greater than 0, but it was '0'
- parameter 'from' must be greater than or equal to 0, but it was '-1'
timestamp: '2023-10-17T16:59:11.237789'
'403':
description: Пользователь не является владельцем вещи
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
example:
status: FORBIDDEN
reason: Access denied
message: 'User with id: 8 is not owner of item with id: 1'
timestamp: '2023-10-19T11:12:52.394164'
'404':
description: Необходимые ресурсы не найдены
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Пользователь не найден:
description: Пользователь не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
Вещь не найдена:
description: Вещь не найдена
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'Item not found with id: 99'
timestamp: '2023-10-19T10:11:42.797793'
/bookings/{bookingId}:
get:
tags:
- Бронирование
summary: Получение бронирования по идентификатору
description: Получить информацию может только инициатор бронирования или владелец вещи, к которой относится это бронирование
operationId: getBookingById
parameters:
- name: bookingId
in: path
description: Идентификатор бронирования
required: true
schema:
type: integer
format: int64
example: 5
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Бронирование найдено
content:
application/json:
schema:
$ref: '#/components/schemas/BookingDto'
'404':
description: Необходимые ресурсы не найдены
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Бронирование не найдено:
description: Бронирование не найдено
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'Booking with id: 99 not found'
timestamp: '2023-10-19T14:43:26.168397'
Доступ не найден:
description: Доступ не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 5 cannot request booking with id: 1'
timestamp: '2023-10-19T14:44:33.880761'
Пользователь не найден:
description: Пользователь не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
patch:
tags:
- Бронирование
summary: Подтверждение или отклонение запроса на бронирование
description: Может быть выполнено только владельцем вещи. Затем статус бронирования становится либо APPROVED, либо REJECTED
operationId: approveOrRejectBooking
parameters:
- name: bookingId
in: path
description: Идентификатор бронирования
required: true
schema:
type: integer
format: int64
example: 5
- name: approved
in: query
description: Подтверждение или отклонение
required: true
schema:
type: boolean
example: true
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Статус бронирования обновлен
content:
application/json:
schema:
$ref: '#/components/schemas/BookingDto'
'400':
description: Запрос составлен некорректно
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Бронирование не ожидает обновление статуса:
description: Бронирование не ожидает обновление статуса
value:
status: BAD_REQUEST
reason: Request cannot be understood by the server due to incorrect syntax
message: 'Booking with id: 1 not awaiting approval'
timestamp: '2023-10-19T14:56:11.384947'
Ошибка в запросе:
description: Ошибка в запросе
value:
status: BAD_REQUEST
reason: Bad Request
message: Required request parameter 'approved' for method parameter type Boolean is not present
timestamp: '2023-10-19T15:09:34.155192'
'404':
description: Необходимые ресурсы не найдены
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Бронирование не найдено:
description: Бронирование не найдено
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'Booking with id: 99 not found'
timestamp: '2023-10-19T14:43:26.168397'
Доступ не найден:
description: Доступ не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 5 cannot request booking with id: 1'
timestamp: '2023-10-19T14:44:33.880761'
Пользователь не найден:
description: Пользователь не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'User with id: 1 not found'
timestamp: '2023-10-17T21:25:18.098461'
/requests/{itemRequestId}:
get:
tags:
- Запрос вещи
summary: Получение данных запроса вещи по идентификатору
description: Получение запроса вещи по его идентификатору вместе с данными об ответах
operationId: getItemRequestsById
parameters:
- name: X-Sharer-User-Id
in: header
description: Идентификатор пользователя
required: true
schema:
type: integer
format: int64
example: 1
- name: itemRequestId
in: path
description: Идентификатор запроса вещи
required: true
schema:
type: integer
format: int64
example: 1
responses:
'200':
description: Запрос вещи найден
content:
application/json:
schema:
$ref: '#/components/schemas/ItemRequestDto'
'404':
description: Необходимые ресурсы не найдены
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
examples:
Запрос не найден:
description: Запрос не найден
value:
status: NOT_FOUND
reason: Requested resource does not exist
message: 'Item request with id: 99 not found'
timestamp: '2023-10-18T15:20:42.426754'
Пользователь не найден: