-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yml
987 lines (937 loc) · 45.2 KB
/
openapi.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
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
openapi: "3.0.1"
info:
title: Pulse API
version: "1.0"
servers:
- url: http://localhost:8080/api
paths:
/ping:
get:
summary: Проверка сервера на готовность принимать запросы
description: |
Данный эндпоинт позволяет понять, что сервер готов принимать входящие запросы.
Программа-чекер будет дожидаться первого успешного ответа от сервера на данный эндпоинт, после чего будет запускать проверку тестовый сценариев.
operationId: ping
responses:
"200":
description: |
Если сервер успешно отвечает на данный запрос, считается, что он готов обрабатывать входящие запросы в API.
Содержимое ответа при этом не валидируется, можно возвращать "ok".
content:
text/plain:
schema:
type: string
example: ok
"500":
description: Если сервер отвечает любым отличным от 200 кодом ответа, считается, что он не готов принимать запросы.
/countries:
get:
summary: Получить список стран
description: |
Получение списка стран с возможной фильтрацией.
Используется на странице регистрации для предоставления возможности выбора страны, к которой относится пользователь.
Если хотя бы один переданный регион является некорректным, весь запрос считается некорректным.
Если никакие из фильтров не переданы, необходимо вернуть все страны.
operationId: listCountries
parameters:
- name: region
description: |
Возвращаемые страны должны относиться только к тем регионам, которые переданы в данном списке.
Если передан пустой список, считайте, что фильтр по региону отсутствует.
in: query
schema:
type: array
items:
$ref: "#/components/schemas/countryRegion"
example:
- Europe
- Asia
responses:
"200":
description: Список стран, соответствующих указанному фильтру. Страны должны быть отсортированы лексикографически по двухбуквенному коду.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/country"
"400":
description: Формат входного запроса не соответствует формату либо переданы неверные значения.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/countries/{alpha2}:
get:
summary: Получить страну по alpha2 коду
description: |
Получение одной страны по её уникальному двухбуквенному коду.
Используется для получения информации по определенной стране.
operationId: getCountry
parameters:
- name: alpha2
description: |
Возвращаемая страна должна иметь указанный alpha2 код.
required: true
in: path
schema:
$ref: "#/components/schemas/countryAlpha2"
responses:
"200":
description: Страна, найденная по указанному коду.
content:
application/json:
schema:
$ref: "#/components/schemas/country"
"404":
description: Страна с указанным кодом не найдена.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/auth/register:
post:
summary: Регистрация нового пользователя
description: |
Используется для регистрации нового пользователя по логину и паролю.
operationId: authRegister
requestBody:
description: Данные для регистрации пользователя.
required: true
content:
application/json:
schema:
type: object
properties:
login:
$ref: "#/components/schemas/userLogin"
email:
$ref: "#/components/schemas/userEmail"
password:
$ref: "#/components/schemas/userPassword"
countryCode:
$ref: "#/components/schemas/countryAlpha2"
isPublic:
$ref: "#/components/schemas/userIsPublic"
phone:
$ref: "#/components/schemas/userPhone"
image:
$ref: "#/components/schemas/userImage"
required:
- login
- email
- password
- countryCode
- isPublic
responses:
"201":
description: В случае успеха возвращается профиль зарегистрированного пользователя
content:
application/json:
schema:
type: object
properties:
profile:
$ref: "#/components/schemas/userProfile"
required:
- profile
"400":
description: |
Регистрационные данные не соответствуют ожидаемому формату и требованиям.
Например, данную ошибку необходимо возвращать в следующих ситуациях (это не полный список):
- Недостаточно "надежный" пароль.
- Страна с указанным кодом не найдена.
- Длина ссылки на аватар пользователя превышает допустимый лимит.
Для ознакомления с форматом и требованиями к регистрационным данным обратите внимание на описание моделей в Open API спецификации.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"409":
description: |
Нарушено требование на уникальность авторизационных данных пользователей.
Данный код ответа должен использоваться, если пользователь с таким e-mail, номером телефона или логином уже зарегистрирован.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/auth/sign-in:
post:
summary: Аутентификация для получения токена
description: |
Процедура аутентификации по логину и паролю позволяет получить токен, который в дальнейшем будет использоваться пользователем для выполнения операций, требующих авторизацию.
Сервер должен генерировать уникальные токены, имеющие время жизни (на усмотрение разработчика, от 1 до 24 часов). После истечения времени действия токен должен быть недействительным и не может использоваться для аутентификации.
Токен является уникальным строковым значением с высокой энтропией (злоумышленник не сможет его "подобрать" перебором). При каждой новой аутентификации генерируется новый уникальный токен, который ранее не был использован. Можно использовать JWT.
В дальнейшем полученный токен будет использоваться для авторизации пользовательских запросов. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`. Следовательно, сервер должен уметь идентифицировать пользователя по токену.
operationId: authSignIn
requestBody:
description: Данные для аутентификации пользователя.
required: true
content:
application/json:
schema:
type: object
properties:
login:
$ref: "#/components/schemas/userLogin"
password:
$ref: "#/components/schemas/userPassword"
required:
- login
- password
responses:
"200":
description: Успешная аутентификация
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: Сгенерированный токен пользователя
minLength: 20
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
required:
- token
"401":
description: Пользователь с указанным логином и паролем не найден
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/me/profile:
get:
summary: Получение собственного профиля
description: |
Используется для получения пользователем его собственного профиля.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: getMyProfile
responses:
"200":
description: Передан действительный токен, в ответе возвращается профиль пользователя.
content:
application/json:
schema:
$ref: "#/components/schemas/userProfile"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
patch:
summary: Редактирование собственного профиля
description: |
Используется для редактирования параметров профиля пользователя.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: patchMyProfile
requestBody:
description: |
В теле запроса перечисляются названия параметров, которые необходимо обновить, и новые значения.
Если значение передано, данное изменение должно быть отражено в профиле пользователя.
Если значение не передано, необходимо оставить прежнее значение параметра.
Если передана пустая структура, ничего изменять не требуется, возвращается успешный ответ.
required: true
content:
application/json:
schema:
type: object
properties:
countryCode:
$ref: "#/components/schemas/countryAlpha2"
isPublic:
$ref: "#/components/schemas/userIsPublic"
phone:
$ref: "#/components/schemas/userPhone"
image:
$ref: "#/components/schemas/userImage"
responses:
"200":
description: Передан действительный токен, в ответе возвращается профиль пользователя с примененными изменениями.
content:
application/json:
schema:
$ref: "#/components/schemas/userProfile"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"400":
description: |
Данные не соответствуют ожидаемому формату и требованиям.
Например, данную ошибку необходимо возвращать в следующих ситуациях (это не полный список):
- Страна с указанным кодом не найдена.
- Длина ссылки на аватар пользователя превышает допустимый лимит.
Для ознакомления с форматом и требованиями к регистрационным данным обратите внимание на описание моделей в Open API спецификации.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"409":
description: |
Нарушено требование на уникальность авторизационных данных пользователей.
Данный код ответа должен использоваться, если указанный номер телефона занят другим пользователем.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/profiles/{login}:
get:
summary: Получение профиля пользователя по логину
description: |
Используется для получения профиля другого пользователя по логину.
Если профиль пользователя публичен (`isPublic: true`), его может получить любой другой пользователь. Если профиль пользователя закрыт, его могут получить пользователи, которых данный пользователь добавил в друзья.
При этом собственный профиль пользователь может получить всегда. Сервер должен идентифицировать пользователя по переданному токену в заголовке `Authorization`.
security:
- bearerAuth: []
parameters:
- name: login
description: Логин пользователя, чей профиль необходимо получить.
required: true
in: path
schema:
$ref: "#/components/schemas/userLogin"
operationId: getProfile
responses:
"200":
description: Пользователь с указанным логином существует и его профиль может быть получен пользователем, осуществившим запрос.
content:
application/json:
schema:
$ref: "#/components/schemas/userProfile"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"403":
description: |
Профиль не может быть получен: либо пользователь с указанным логином не существует, либо у отправителя запроса нет доступа к запрашиваемому профилю.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/me/updatePassword:
post:
summary: Обновление пароля
description: |
Используется для обновления пароля.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
Важно: после успешного обновления пароля ранее выписанные токены должны быть деактивированы. Как только сервер вернет успешный ответ на данный запрос, пользователь не сможет совершить какие-либо операции с ранее созданными токенами (запросы со старыми токенами должны получать соответствующий ошибочный статус код).
security:
- bearerAuth: []
operationId: updatePassword
requestBody:
description: |
В теле запроса передается старый и новый пароли. Пароль может быть обновлен только в случае передачи правильного значения старого пароля.
required: true
content:
application/json:
schema:
type: object
properties:
oldPassword:
$ref: "#/components/schemas/userPassword"
newPassword:
$ref: "#/components/schemas/userPassword"
required:
- oldPassword
- newPassword
responses:
"200":
description: Пароль успешно обновлен и ранее выпущенные токены отозваны.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Должно принимать значение `ok`.
example: ok
required:
- status
"400":
description: Новый пароль не соответствует требованиям безопасности.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"403":
description: Указанный пароль не совпадает с действительным.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/friends/add:
post:
summary: Добавить пользователя в друзья
description: |
Позволяет добавить другого пользователя к себе в друзья.
Если указанный пользователь уже добавлен в друзья, верните успешный ответ.
Если пользователь добавляет в друзья самого себя, верните успешный ответ (добавлять в друзья при этом не нужно).
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: friendsAdd
requestBody:
description: |
В теле запроса передается логин пользователя.
required: true
content:
application/json:
schema:
type: object
properties:
login:
$ref: "#/components/schemas/userLogin"
required:
- login
responses:
"200":
description: Операция завершилась успешно.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Должно принимать значение `ok`.
example: ok
required:
- status
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"404":
description: Пользователь с указанным логином не найден.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/friends/remove:
post:
summary: Удалить пользователя из друзей
description: |
Позволяет удалить пользователя из друзей.
Если указанного пользователя нет в друзьях, верните успешный ответ.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: friendsRemove
requestBody:
description: |
В теле запроса передается логин пользователя.
required: true
content:
application/json:
schema:
type: object
properties:
login:
$ref: "#/components/schemas/userLogin"
required:
- login
responses:
"200":
description: Операция завершилась успешно.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Должно принимать значение `ok`.
example: ok
required:
- status
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/friends:
get:
summary: Получение списка друзей
description: |
Используется для получения списка своих друзей (пользователей, кого инициатор запроса добавил в друзья).
Для плавной работы приложения используется пагинация.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: friendsList
parameters:
- $ref: "#/components/parameters/paginationLimit"
- $ref: "#/components/parameters/paginationOffset"
responses:
"200":
description: |
Список друзей пользователя, отсортированный по убыванию по дате последнего добавления в друзья.
В начале идут друзья, которые были добавлены совсем недавно.
content:
application/json:
schema:
type: array
items:
type: object
description: Описание друга.
properties:
login:
$ref: "#/components/schemas/userLogin"
addedAt:
type: string
description: |
Время и дата, когда данный пользователь был добавлен в друзья в последний раз.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
required:
- login
- addedAt
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/posts/new:
post:
summary: Отправить публикацию
description: |
Используется для отправки публикации в ленту.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: submitPost
requestBody:
description: Информация о публикации.
required: true
content:
application/json:
schema:
type: object
properties:
content:
$ref: "#/components/schemas/postContent"
tags:
$ref: "#/components/schemas/postTags"
required:
- content
- tags
responses:
"200":
description: Публикация сохранена. Сервер назначает уникальный идентификатор и время создания публикации.
content:
application/json:
schema:
$ref: "#/components/schemas/post"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/posts/{postId}:
get:
summary: Получить публикацию по ID
description: |
Используется для получения публикации по её идентификатору.
Если публикация принадлежит пользователю с публичным профилем, её может получить любой другой аутентифицированный пользователь.
Если профиль автора закрыт, она доступна автору и пользователям, кого автор добавил в друзья.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: getPostById
parameters:
- name: postId
description: ID публикации.
required: true
in: path
schema:
$ref: "#/components/schemas/postId"
responses:
"200":
description: Публикация найдена.
content:
application/json:
schema:
$ref: "#/components/schemas/post"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"404":
description: Указанный пост не найден либо к нему нет доступа.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/posts/feed/my:
get:
summary: Получить ленту со своими постами
description: |
Используется для получения списка своих постов.
Для плавной работы приложения используется пагинация.
Можете считать, что пользователей с логином `my` не будет.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: getMyFeed
parameters:
- $ref: "#/components/parameters/paginationLimit"
- $ref: "#/components/parameters/paginationOffset"
responses:
"200":
description: |
Список публикаций пользователя, отсортированных по убыванию по дате публикации.
В начале идут публикации, которые были добавлены совсем недавно.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/post"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/posts/feed/{login}:
get:
summary: Получить ленту с постами другого пользователя
description: |
Используется для получения списка публикаций другого пользователя.
Если профиль пользователя открыт, его посты доступны всем.
Если профиль пользователя закрыт, его посты доступны самому пользователю и пользователям, кого он добавил в друзья.
Для плавной работы приложения используется пагинация.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: getFeedByOthers
parameters:
- name: login
description: Логин пользователя.
required: true
in: path
schema:
$ref: "#/components/schemas/userLogin"
- $ref: "#/components/parameters/paginationLimit"
- $ref: "#/components/parameters/paginationOffset"
responses:
"200":
description: |
Список публикаций пользователя, отсортированных по убыванию по дате публикации.
В начале идут публикации, которые были добавлены совсем недавно.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/post"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"404":
description: Пользователь не найден либо к нему нет доступа.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/posts/{postId}/like:
post:
summary: Лайк поста
description: |
Лайк поста.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: likstPost
parameters:
- name: postId
description: ID публикации.
required: true
in: path
schema:
$ref: "#/components/schemas/postId"
responses:
"200":
description: Реакция засчитана, возвращайте пубикацию с актуальным числом лайков и дизлайков.
content:
application/json:
schema:
$ref: "#/components/schemas/post"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"404":
description: Указанный пост не найден либо к нему нет доступа.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
/posts/{postId}/dislike:
post:
summary: Дизлайк поста
description: |
Дизлайк поста.
Сервер должен идентифицировать пользователя по переданному токену. Значение токена будет подставляться в заголовок `Authorization` в формате `Bearer {token}`.
security:
- bearerAuth: []
operationId: dislikePost
parameters:
- name: postId
description: ID публикации.
required: true
in: path
schema:
$ref: "#/components/schemas/postId"
responses:
"200":
description: Реакция засчитана, возвращайте пубикацию с актуальным числом лайков и дизлайков.
content:
application/json:
schema:
$ref: "#/components/schemas/post"
"401":
description: Переданный токен не существует либо некорректен.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
"404":
description: Указанный пост не найден либо к нему нет доступа.
content:
application/json:
schema:
$ref: "#/components/schemas/errorResponse"
components:
schemas:
countryAlpha2:
type: string
description: Двухбуквенный код, уникально идентифицирующий страну
maxLength: 2
pattern: "[a-zA-Z]{2}"
example: RU
countryRegion:
type: string
description: Географический регион, к которому относится страна
enum:
- Europe
- Africa
- Americas
- Oceania
- Asia
country:
type: object
description: Информация о стране из стандарта ISO 3166
properties:
name:
type: string
description: Полное название страны
maxLength: 100
alpha2:
$ref: "#/components/schemas/countryAlpha2"
alpha3:
type: string
description: Трехбуквенный код страны
maxLength: 3
pattern: "[a-zA-Z]{3}"
region:
$ref: "#/components/schemas/countryRegion"
required:
- name
- alpha2
- alpha3
example:
name: Burkina Faso
alpha2: BF
alpha3: BFA
region: Africa
userLogin:
type: string
description: Логин пользователя
maxLength: 30
pattern: "[a-zA-Z0-9-]+"
example: yellowMonkey
userEmail:
type: string
description: E-mail пользователя
maxLength: 50
minLength: 1
example: [email protected]
userPassword:
type: string
description: |
Пароль пользователя, к которому предъявляются следующие требования:
- Длина пароля не менее 6 символов.
- Присутствуют латинские символы в нижнем и верхнем регистре.
- Присутствует минимум одна цифра.
minLength: 6
maxLength: 100
example: $aba4821FWfew01#.fewA$
userIsPublic:
type: boolean
description: |
Является ли данный профиль публичным.
Публичные профили доступны другим пользователям: если профиль публичный, любой пользователь платформы сможет получить информацию о пользователе.
example: true
userPhone:
type: string
description: Номер телефона пользователя в формате +123456789
pattern: \+[\d]+
example: "+74951239922"
maxLength: 20
userImage:
type: string
description: Ссылка на фото для аватара пользователя
example: https://http.cat/images/100.jpg
maxLength: 200
minLength: 1
userProfile:
type: object
description: Информация о профиле пользователя
properties:
login:
$ref: "#/components/schemas/userLogin"
email:
$ref: "#/components/schemas/userEmail"
countryCode:
$ref: "#/components/schemas/countryAlpha2"
isPublic:
$ref: "#/components/schemas/userIsPublic"
phone:
$ref: "#/components/schemas/userPhone"
image:
$ref: "#/components/schemas/userImage"
required:
- login
- email
- countryCode
- isPublic
postId:
type: string
description: Уникальный идентификатор публикации, присвоенный сервером.
example: 550e8400-e29b-41d4-a716-446655440000
maxLength: 100
postContent:
type: string
description: Текст публикации.
example: Свеча на 400! Покупаем, докупаем и фиксируем прибыль.
maxLength: 1000
postTags:
type: array
description: Список тегов публикации.
items:
type: string
description: Значение тега.
example: тинькофф
maxLength: 20
example:
- тинькофф
- спббиржа
- moex
post:
type: object
description: Пользовательская публикация.
properties:
id:
$ref: "#/components/schemas/postId"
content:
$ref: "#/components/schemas/postContent"
author:
$ref: "#/components/schemas/userLogin"
tags:
$ref: "#/components/schemas/postTags"
createdAt:
type: string
description: |
Серверная дата и время в момент, когда пользователь отправил данную публикацию.
Передается в формате RFC3339.
example: 2006-01-02T15:04:05Z07:00
likesCount:
type: integer
minimum: 0
default: 0
description: Число лайков, набранное публикацией.
dislikesCount:
type: integer
minimum: 0
default: 0
description: Число дизлайков, набранное публикацией.
required:
- id
- content
- author
- tags
- createdAt
- likesCount
- dislikesCount
errorResponse:
type: object
description: Используется для возвращения ошибки пользователю
properties:
reason:
type: string
description: Описание ошибки в свободной форме
minLength: 5
required:
- reason
example:
reason: <объяснение, почему запрос пользователя не может быть обработан>
parameters:
paginationLimit:
in: query
name: limit
required: false
description: |
Максимальное число возвращаемых объектов. Используется для запросов с пагинацией.
Сервер должен возвращать максимальное допустимое число объектов.
schema:
type: integer
format: int32
minimum: 0
maximum: 50
default: 5
paginationOffset:
in: query
name: offset
required: false
description: |
Какое количество объектов должно быть пропущено с начала. Используется для запросов с пагинацией.
schema:
type: integer
format: int32
default: 0
minimum: 0
securitySchemes:
bearerAuth:
type: http
scheme: bearer