-
Notifications
You must be signed in to change notification settings - Fork 0
/
api-docs.yaml
667 lines (667 loc) · 15.8 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
openapi: 3.0.1
info:
title: OpenAPI definition
version: v0
servers:
- url: http://localhost:8443
description: Generated server url
paths:
/api/users/{username}/follows:
put:
tags:
- user-rest-controller
summary: Current user follows another user by its name
operationId: follow
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"403":
description: Current user not logged in
"404":
description: User not found
"200":
description: User found and followed/unfollowed state changed
content:
application/json:
schema:
$ref: '#/components/schemas/User'
/api/users/{id}:
put:
tags:
- user-rest-controller
summary: (Admin) Ban/unban user by its id
operationId: banUser
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
"403":
description: Admin access required
"200":
description: User found and banned/unbanned state changed
content:
application/json:
schema:
$ref: '#/components/schemas/User'
"404":
description: User not found
/api/posts/{postId}/upvotes:
put:
tags:
- post-rest-controller
summary: Current user upvote a post
operationId: upvotePost
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"403":
description: Current user not logged in
"404":
description: Post not found
"200":
description: User found and upvoted the post
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
/api/posts/{postId}/downvotes:
put:
tags:
- post-rest-controller
summary: Current user downvote a post
operationId: downvotePost
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"403":
description: Current user not logged in
"200":
description: User found and downvoted the post
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
"404":
description: Post not found
/api/users/:
post:
tags:
- user-rest-controller
summary: Register a new user
operationId: register
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegistrationRequest'
required: true
responses:
"201":
description: User created
content:
application/json:
schema:
$ref: '#/components/schemas/User'
"400":
description: Username/password is shorter than 4 characters or invalid email
address
"403":
description: Username already taken
/api/topics/:
post:
tags:
- topic-rest-controller
summary: Create topic
operationId: createTopic
parameters:
- name: topic
in: query
required: true
schema:
$ref: '#/components/schemas/Topic'
responses:
"201":
description: Topic created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Topic'
"403":
description: Create topic only for admin
/api/posts/:
post:
tags:
- post-rest-controller
summary: Create new post
operationId: createPost
parameters:
- name: post
in: query
required: true
schema:
$ref: '#/components/schemas/Post'
responses:
"403":
description: Can't create post if not registered
"201":
description: Post created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
/api/comments/{postId}:
post:
tags:
- comment-rest-controller
summary: Delete a comment of a post
operationId: createComment
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Data'
required: true
responses:
"201":
description: Comment added
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Comment'
"403":
description: Can´t comment if not registered
/api/auth/sign-out:
post:
tags:
- auth-rest-controller
summary: Sign-out user
operationId: logOut
responses:
"200":
description: Sign-out successful
content:
'*/*':
schema:
$ref: '#/components/schemas/AuthResponse'
/api/auth/sign-in:
post:
tags:
- auth-rest-controller
summary: Sign-in user with credentials
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:
"403":
description: Sign-in unsuccessful
content:
'*/*':
schema:
$ref: '#/components/schemas/AuthResponse'
"200":
description: Sign-in successful
content:
'*/*':
schema:
$ref: '#/components/schemas/AuthResponse'
/api/users/{username}:
get:
tags:
- user-rest-controller
summary: Get a user by its username
operationId: getUser
parameters:
- name: username
in: path
required: true
schema:
type: string
responses:
"200":
description: User found
content:
application/json:
schema:
$ref: '#/components/schemas/User'
"404":
description: User not found
/api/topics/{topicId}:
get:
tags:
- topic-rest-controller
summary: Get specific topic
operationId: getTopic
parameters:
- name: topicId
in: path
required: true
schema:
type: integer
format: int64
responses:
"404":
description: Topic not found
"200":
description: Topic found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Topic'
delete:
tags:
- topic-rest-controller
summary: Delete specific topic
operationId: deleteTopic
parameters:
- name: topicId
in: path
required: true
schema:
type: integer
format: int64
responses:
"404":
description: Topic not found
"200":
description: Topic deleted
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Topic'
"403":
description: Delete topic only for admin
/api/posts/{postId}:
get:
tags:
- post-rest-controller
summary: Get specific post
operationId: getPost
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: Post found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
"404":
description: Post not found
delete:
tags:
- post-rest-controller
summary: Delete specific post
operationId: deletePost
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"403":
description: Can't delete other one post
"200":
description: Post deleted
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
"404":
description: Post not found
/api/comments/user/{userId}:
get:
tags:
- comment-rest-controller
summary: Get all the comments of an user
operationId: getUserComments
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: User found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Comment'
"404":
description: User not found
/api/comments/post/{postId}:
get:
tags:
- comment-rest-controller
summary: Get all the comments of a post
operationId: getPostComments
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: Post found
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Comment'
"404":
description: Post not found
/api/ajax/posts:
get:
tags:
- ajax-rest-controller
summary: Load more posts
operationId: getNewPosts
parameters:
- name: page
in: query
required: true
schema:
type: integer
format: int32
responses:
"200":
description: New posts loaded
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
"404":
description: No new posts found
/api/ajax/followed-users/posts:
get:
tags:
- ajax-rest-controller
summary: Load more posts from followed-users
operationId: getFollowedUsersPosts
parameters:
- name: page
in: query
required: true
schema:
type: integer
format: int32
responses:
"200":
description: New posts loaded
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Post'
"404":
description: No new posts found
/api/comments/{postId}/{commentId}:
delete:
tags:
- comment-rest-controller
summary: Delete a comment of a post
operationId: deleteComment
parameters:
- name: postId
in: path
required: true
schema:
type: integer
format: int64
- name: commentId
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: Comment deleted
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Comment'
"403":
description: Can´t delete other one comment
"404":
description: Post or comment not found
components:
schemas:
Comment:
type: object
properties:
id:
type: integer
format: int64
author:
$ref: '#/components/schemas/User'
date:
type: string
format: date-time
content:
type: string
imagePath:
type: string
'@Id':
type: integer
format: int32
GrantedAuthority:
type: object
properties:
authority:
type: string
Post:
type: object
properties:
author:
$ref: '#/components/schemas/User'
date:
type: string
format: date-time
title:
type: string
topics:
type: array
items:
$ref: '#/components/schemas/Topic'
items:
type: array
items:
$ref: '#/components/schemas/PostItem'
comments:
type: array
items:
$ref: '#/components/schemas/Comment'
'@Id':
type: integer
format: int32
PostItem:
type: object
properties:
description:
type: string
imageFile:
type: object
properties:
binaryStream:
type: object
writeOnly: true
'@Id':
type: integer
format: int32
Topic:
type: object
properties:
name:
type: string
description:
type: string
posts:
type: array
items:
$ref: '#/components/schemas/Post'
'@Id':
type: integer
format: int32
User:
type: object
properties:
id:
type: integer
format: int64
date:
type: string
format: date-time
username:
type: string
password:
type: string
email:
type: string
role:
type: string
enum:
- USER
- ADMIN
enabled:
type: boolean
locked:
type: boolean
bio:
type: string
imagePath:
type: string
posts:
type: array
items:
$ref: '#/components/schemas/Post'
comments:
type: array
items:
$ref: '#/components/schemas/Comment'
admin:
type: boolean
authorities:
type: array
items:
$ref: '#/components/schemas/GrantedAuthority'
accountNonLocked:
type: boolean
credentialsNonExpired:
type: boolean
accountNonExpired:
type: boolean
'@Id':
type: integer
format: int32
RegistrationRequest:
type: object
properties:
username:
type: string
email:
type: string
password:
type: string
Data:
type: object
properties:
content:
type: string
imagePath:
type: string
AuthResponse:
type: object
properties:
status:
type: string
enum:
- SUCCESS
- FAILURE
message:
type: string
error:
type: string
LoginRequest:
type: object
properties:
username:
type: string
password:
type: string