-
Notifications
You must be signed in to change notification settings - Fork 0
/
api-docs.yaml
2846 lines (2846 loc) · 69.4 KB
/
api-docs.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: OpenAPI definition
version: v0
servers:
- url: https://localhost:8443
description: Generated server url
paths:
/api/v1/users/{username}:
get:
tags:
- api-user-controller
summary: Get user by username or email
operationId: getUser
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"200":
description: Users found
content:
application/json:
schema:
$ref: "#/components/schemas/User_UserBasicView"
"404":
description: Users not found
put:
tags:
- api-user-controller
summary: Update user data
operationId: updateUser
parameters:
- name: username
in: path
required: true
schema:
type: string
- name: action
in: query
required: true
schema:
type: string
- name: otherUsername
in: query
required: false
schema:
type: string
responses:
"422":
description: Unprocessable Entity
"400":
description: Bad Request
"200":
description: User updated
content:
application/json:
schema:
$ref: "#/components/schemas/User_UserBasicView"
"401":
description: Unauthorized
"404":
description: User not found
delete:
tags:
- api-user-controller
summary: Delete user
operationId: deleteUser
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"401":
description: Unauthorized
"403":
description: Forbidden
"404":
description: User not found
"200":
description: User deleted
content:
'*/*':
schema:
type: string
/api/v1/users/{username}/pictures:
get:
tags:
- api-user-controller
summary: Get user's profile picture
operationId: getProfilePicture
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"404":
description: Profile picture not found
"500":
description: Internal Server Error
"200":
description: Profile picture found
content:
application/json:
schema:
$ref: "#/components/schemas/User"
put:
tags:
- api-user-controller
summary: Change user's profile picture
operationId: changeProfilePicture
parameters:
- name: username
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
required:
- file
type: object
properties:
file:
type: string
format: binary
responses:
"400":
description: Bad Request
"500":
description: Internal Server Error
"200":
description: Profile picture changed
content:
application/json:
schema:
$ref: "#/components/schemas/User_UserBasicView"
"401":
description: Unauthorized
"404":
description: User not found
/api/v1/replies/{replyId}:
get:
tags:
- api-post-controller
summary: Get reply by ID
operationId: getReplyById
parameters:
- name: replyId
in: path
required: true
schema:
type: integer
format: int64
responses:
"404":
description: Reply not found
"200":
description: Reply found
content:
application/json:
schema:
$ref: "#/components/schemas/Reply_ReplyInfo"
put:
tags:
- api-post-controller
summary: Modify a reply (like)
operationId: likeReply
parameters:
- name: replyId
in: path
required: true
schema:
type: integer
format: int64
- name: action
in: query
required: true
schema:
type: string
responses:
"404":
description: Reply not found
"401":
description: Unauthorized
"200":
description: Reply liked
content:
application/json:
schema:
$ref: "#/components/schemas/Reply_ReplyInfo"
delete:
tags:
- api-post-controller
summary: Delete a reply
operationId: deleteReply
parameters:
- name: replyId
in: path
required: true
schema:
type: integer
format: int64
responses:
"204":
description: Reply deleted
content:
'*/*':
schema:
type: string
"404":
description: Reply not found
"403":
description: Forbidden
/api/v1/posts/{postId}:
get:
tags:
- api-post-controller
summary: Get post by ID
operationId: getPostById
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: Post found
content:
application/json:
schema:
$ref: "#/components/schemas/Post_PostInfo"
"404":
description: Post not found
content:
'*/*':
schema:
$ref: "#/components/schemas/Post_PostInfo"
put:
tags:
- api-post-controller
summary: Edit a post (or upvote/downvote)
operationId: editPost
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
- name: action
in: query
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/PostDTO_PostInfo"
responses:
"200":
description: Post edited
content:
application/json:
schema:
$ref: "#/components/schemas/Post_PostInfo"
"404":
description: Post not found
"400":
description: Invalid input
"403":
description: Forbidden
"401":
description: Unauthorized
delete:
tags:
- api-post-controller
summary: Delete a post
operationId: deletePost
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"204":
description: Post deleted
content:
'*/*':
schema:
type: string
"404":
description: Post not found
"403":
description: Forbidden
/api/v1/posts/{postId}/pictures:
get:
tags:
- api-post-controller
summary: Get post image
operationId: getPostImage
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: Post image found
content:
image/jpeg: {}
image/png: {}
"404":
description: Post image not found
put:
tags:
- api-post-controller
summary: Update post image
operationId: updatePostImage
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
- name: action
in: query
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
image:
type: string
format: binary
responses:
"200":
description: Post image updated
content:
application/json:
schema:
$ref: "#/components/schemas/Post_PostInfo"
"404":
description: Post not found
"400":
description: Invalid input
"403":
description: Forbidden
delete:
tags:
- api-post-controller
summary: Delete post image
operationId: deletePostImage
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"404":
description: Post not found
"403":
description: Forbidden
"204":
description: Post image deleted
content:
'*/*':
schema:
type: string
/api/v1/communities/{id}:
get:
tags:
- api-community-controller
summary: Get a community by ID
operationId: getCommunityById
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"404":
description: Community not found
"200":
description: Found the community
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityBasicInfo"
put:
tags:
- api-community-controller
summary: Update a community
operationId: updateCommunity
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
type: object
additionalProperties:
type: string
required: true
responses:
"404":
description: Community not found
"422":
description: Unprocessable Entity
"200":
description: Updated the community
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityBasicInfo"
"400":
description: Bad Request
"401":
description: Unauthorized
delete:
tags:
- api-community-controller
summary: Delete a community
operationId: deleteCommunity
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"404":
description: Community not found
"200":
description: Deleted the community
content:
application/json:
schema:
$ref: "#/components/schemas/Community"
"401":
description: Unauthorized
/api/v1/communities/{id}/users/{username}:
get:
tags:
- api-community-controller
summary: Check if a user is a member of a community
operationId: isUserMember
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: username
in: path
required: true
schema:
type: string
responses:
"422":
description: Unprocessable Entity
"200":
description: User is a member of the community
content:
application/json:
schema:
$ref: "#/components/schemas/Community"
"404":
description: User is not a member of the community
"401":
description: Unauthorized
put:
tags:
- api-community-controller
summary: "Add, remove or ban a user from a community"
operationId: manageCommunityUsers
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: username
in: path
required: true
schema:
type: string
- name: action
in: query
required: true
schema:
type: string
- name: duration
in: query
required: false
schema:
type: string
- name: reason
in: query
required: false
schema:
type: string
responses:
"422":
description: Unprocessable Entity
"404":
description: Entity not found
"200":
description: Action succesfully performed
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityUsersInfo"
"401":
description: Unauthorized
"403":
description: Forbidden
/api/v1/communities/{id}/pictures:
get:
tags:
- api-community-controller
summary: Get the banner of a community
operationId: getCommunityBanner
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"404":
description: Entity not found
"200":
description: Found the banner
content:
image/jpeg:
schema:
$ref: "#/components/schemas/Community"
"500":
description: Internal Server Error
"401":
description: Unauthorized
put:
tags:
- api-community-controller
summary: Upload a banner to a community
operationId: uploadCommunityBanner
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: action
in: query
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
file:
type: string
format: binary
responses:
"404":
description: Entity not found
"400":
description: Bad Request
"500":
description: Internal Server Error
"200":
description: Uploaded the banner to the community
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityBasicInfo"
"401":
description: Unauthorized
/api/v1/communities/{id}/moderators/{username}:
get:
tags:
- api-community-controller
summary: Check if a user is a moderator of a community
operationId: isUserModeratorOfCommunity
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: username
in: path
required: true
schema:
type: string
responses:
"422":
description: Unprocessable Entity
"200":
description: Found the moderator
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityUsersInfo"
"404":
description: Entity not found
"401":
description: Unauthorized
put:
tags:
- api-community-controller
summary: Add or remove a moderator from a community
operationId: manageModerators
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: username
in: path
required: true
schema:
type: string
- name: action
in: query
required: true
schema:
type: string
responses:
"422":
description: Unprocessable Entity
"404":
description: Entity not found
"200":
description: Action succesfully performed
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityUsersInfo"
"401":
description: Unauthorized
/api/v1/users:
get:
tags:
- api-user-controller
summary: "Search users by username, email, alias or description. Search Engine's\
\ default behaviour"
operationId: searchUsers
parameters:
- name: query
in: query
required: true
schema:
type: string
- name: orderByCreationDate
in: query
required: true
schema:
type: boolean
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: size
in: query
required: false
schema:
type: integer
format: int32
default: 10
responses:
"200":
description: Users found
content:
application/json:
schema:
$ref: "#/components/schemas/User_UserBasicView"
"400":
description: Bad Request
"404":
description: User not found
post:
tags:
- api-user-controller
summary: Register a new user
operationId: registerUser
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/SignupRequestDTO_UserBasicView"
responses:
"201":
description: User registered
content:
application/json:
schema:
$ref: "#/components/schemas/User_UserBasicView"
"400":
description: Bad Request
"409":
description: Conflict
/api/v1/refresh:
post:
tags:
- api-session-controller
summary: Refresh token
operationId: refreshToken
parameters:
- name: refreshToken
in: cookie
required: false
schema:
type: string
responses:
"200":
description: Token refreshed
content:
application/json:
schema:
$ref: "#/components/schemas/AuthResponse"
"400":
description: Invalid token
content:
'*/*':
schema:
$ref: "#/components/schemas/AuthResponse"
/api/v1/posts/{postId}/replies:
get:
tags:
- api-post-controller
summary: Search replies by post
operationId: searchRepliesByPost
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
- name: criteria
in: query
required: true
schema:
type: string
- name: query
in: query
required: true
schema:
type: string
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
- name: size
in: query
required: false
schema:
type: integer
format: int32
default: 10
responses:
"404":
description: Replies not found
"200":
description: Replies found
content:
application/json:
schema:
$ref: "#/components/schemas/Reply_ReplyInfo"
post:
tags:
- api-post-controller
summary: Create a reply
operationId: createReply
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
type: object
additionalProperties:
type: string
required: true
responses:
"201":
description: Reply created
content:
application/json:
schema:
$ref: "#/components/schemas/Reply_ReplyInfo"
"413":
description: Payload too large
"400":
description: Invalid input
"401":
description: Unauthorized
"403":
description: Forbidden
/api/v1/logout:
post:
tags:
- api-session-controller
summary: Logout
operationId: logout
responses:
"200":
description: Logout successful
content:
application/json:
schema:
$ref: "#/components/schemas/AuthResponse"
/api/v1/login:
post:
tags:
- api-session-controller
summary: Login
operationId: login
parameters:
- name: accessToken
in: cookie
required: false
schema:
type: string
- name: refreshToken
in: cookie
required: false
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/LoginRequest"
required: true
responses:
"200":
description: Login successful
content:
application/json:
schema:
$ref: "#/components/schemas/AuthResponse"
"400":
description: Invalid credentials
content:
'*/*':
schema:
$ref: "#/components/schemas/AuthResponse"
/api/v1/communities:
get:
tags:
- api-community-controller
summary: |
Get communities by specified criteria and sort:
Default: search by name and description. Sortings: creationDate, members, lastPostDate, alphabetical (default)
General: get all communities (no query). Sortings: creationDate, lastPostDate, members, alphabetical (default)
Admin: get communities by admin username. Sortings: NONE
Name: search by name. Sortings: creationDate, lastPostDate, members, alphabetical (default)
Description: search by description. Sortings: creationDate, lastPostDate, members, alphabetical (default)
operationId: getCommunitiesByName
parameters:
- name: query
in: query
required: false
schema:
type: string
- name: page
in: query
required: true
schema:
type: integer
format: int32
- name: size
in: query
required: true
schema:
type: integer
format: int32
- name: sort
in: query
required: false
schema:
type: string
- name: by
in: query
required: true
schema:
type: string
responses:
"204":
description: No content
"400":
description: Missing parameter
"200":
description: Found communities
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityBasicInfo"
post:
tags:
- api-community-controller
summary: Create a community
operationId: createCommunity
requestBody:
content:
application/json:
schema:
type: object
additionalProperties:
type: string
required: true
responses:
"422":
description: Unprocessable Entity
"201":
description: Created the community
content:
application/json:
schema:
$ref: "#/components/schemas/Community_CommunityBasicInfo"
"400":
description: Bad Request
"401":
description: Unauthorized
"409":
description: Conflict
/api/v1/communities/{communityID}/posts:
get:
tags:
- api-post-controller
summary: Get posts of a community using its ID
operationId: getCommunityPosts
parameters:
- name: communityID
in: path
required: true
schema:
type: integer
format: int64
- name: count
in: query
required: false
schema:
type: boolean
default: false
- name: page