-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathswagger.yaml
643 lines (634 loc) · 15.6 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
openapi: 3.0.0
info:
title: twitterGram
description: A social media API influenced greatly by twitter, built with node, typescript, express, sequelize and a lot more.
contact: {}
version: "1.0"
servers:
- url: https://twitter-gram-api.herokuapp.com/api/v1
variables: {}
paths:
/users:
post:
tags:
- Auth
summary: create user
description: This is the route to register a user unto the app.
operationId: createuser
parameters: []
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/createuserrequest"
example:
firstName: John
lastName: Doe
email: [email protected]
password: someSecret
required: true
responses:
"200":
description: ""
headers: {}
deprecated: false
security: []
/sessions:
post:
tags:
- Auth
summary: create session
description: This endpoint returns a session with contains the access token and refresh token. The api expects an "x-refresh" header which must be set to the refresh token that was sent.
operationId: createsession
parameters: []
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/createsessionrequest"
example:
email: [email protected]
password: someSecret
required: true
responses:
"200":
description: ""
headers: {}
deprecated: false
security: []
get:
tags:
- Auth
summary: get sessions
description: This route gets all the valid sessions that a user has.
operationId: getsessions
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
delete:
tags:
- Auth
summary: delete session
description: This route deletes all the valid sessions that a user has. Use this route to log out a user.
operationId: deletesession
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/posts:
post:
tags:
- Post
summary: create post
description: You can create post with this route
operationId: createpost
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
caption:
type: string
file:
type: string
format: binary
required: false
responses:
"200":
description: ""
headers: {}
deprecated: false
get:
tags:
- Post
summary: get feeds
description: This gets the post of those the user follows. user must follow other's to see their posts
operationId: getfeeds
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/posts/user:
get:
tags:
- Post
summary: get all user's post
description: This route returns all of the user's posts
operationId: getalluser'spost
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/posts/{postId}:
parameters:
- in: path
name: postId
schema:
type: integer
required: true
description: The post ID
get:
tags:
- Post
summary: get a post
description: Returns a particular post given the post id as params
operationId: getapost
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
delete:
tags:
- Post
summary: delete post
description: >-
Use this route to delete posts given the post id as params
NB: Only the owner of the post can delete the post
operationId: deletepost
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
patch:
tags:
- Post
summary: update post
description: >-
This route is used to update user's post, it requires the post id and the new post content.
NB: Only the owner of the post can update the post
operationId: updatepost
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
- name: postId
in: path
description: ""
required: true
style: simple
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- file
type: object
properties:
file:
type: string
required: false
responses:
"200":
description: ""
headers: {}
deprecated: false
/follow:
post:
tags:
- Follow
summary: follow user
description: This route is used to follow other users. The id of the user to follow is sent through the request body.
operationId: followuser
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
requestBody:
description: ""
content:
application/json:
schema:
$ref: "#/components/schemas/followuserrequest"
example:
followedId: 385395ee-5749-49c7-9338-03d889bf8061
required: true
responses:
"200":
description: ""
headers: {}
deprecated: false
delete:
tags:
- Follow
summary: unfollow user
description: Like the follow user route, this route requires the id of the user to be unfollowed in the request body.
operationId: unfollowuser
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
get:
tags:
- Follow
summary: get all followers
description: You can get all of a user's followers with this route.
operationId: getallfollowers
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/follow/following:
get:
tags:
- Follow
summary: get all following
description: This route returns all the users a particular user follows
operationId: getallfollowing
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/comments:
post:
tags:
- Comment
summary: create comment
description: This route is used to comment on a particular post
operationId: createcomment
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
text:
type: string
file:
type: string
format: binary
required: true
responses:
"200":
description: ""
headers: {}
deprecated: false
/comments/{commentId}:
parameters:
- in: path
name: commentId
schema:
type: integer
required: true
description: The post ID
patch:
tags:
- Comment
summary: edit comment
description: >-
User's comments are updated with this route.
Again, only the user that created the comment can update it.
operationId: editcomment
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- file
type: object
properties:
file:
type: string
required: false
responses:
"200":
description: ""
headers: {}
deprecated: false
delete:
tags:
- Comment
summary: delete comment
description: This route is used to delete a comment.
operationId: deletecomment
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/likes:
get:
tags:
- Like
summary: toggle like on post or comment
description: >-
This route can be used to like either a post or a comment given the post or comment id as a query params.
You can also hit this endpoint to unlike a post or comment
operationId: togglelikeonpostorcomment
parameters:
- name: commentId
in: query
description: "comment id you want to like"
style: form
explode: true
schema:
type: integer
format: int32
- name: postId
in: query
description: "Post id you want to like"
style: form
explode: true
schema:
type: integer
format: int32
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/replies:
post:
tags:
- Reply
summary: create reply
description: >-
This route is used to make replies to either a post or a comment, given the postId or commentId as request sent by the body.
Under the hood, a reply is also a comment, so you can use the comment route to update and delete the replies.
operationId: createreply
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
text:
type: string
file:
type: string
format: binary
required: true
responses:
"200":
description: ""
headers: {}
deprecated: false
/retweet/{postId}:
post:
tags:
- Retweet
summary: create retweet
description: Just like the normal retweet on the twitter app, this route is used to make retweets on posts. The post id to be retweeted is sent as a param in the request.
operationId: createretweet
parameters:
- in: path
name: postId
schema:
type: integer
required: true
description: Numeric ID of the post to retweet
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
/posts/image/{postId}:
parameters:
- in: path
name: postId
schema:
type: string
required: true
description: The post ID
get:
tags:
- Image
summary: get image
description: Get an image
operationId: getimage
parameters:
- name: x-refresh
in: header
description: ""
required: true
style: simple
schema:
type: string
responses:
"200":
description: ""
headers: {}
deprecated: false
components:
schemas:
createuserrequest:
title: createuserrequest
required:
- firstName
- lastName
- email
- password
type: object
properties:
firstName:
type: string
lastName:
type: string
email:
type: string
password:
type: string
example:
firstName: Emmanuella
lastName: Olubo
email: [email protected]
password: someSecret
createsessionrequest:
title: createsessionrequest
required:
- email
- password
type: object
properties:
email:
type: string
password:
type: string
example:
email: [email protected]
password: someSecret
followuserrequest:
title: followuserrequest
required:
- followedId
type: object
properties:
followedId:
type: string
example:
followedId: 385395ee-5749-49c7-9338-03d889bf8061
unfollowuserrequest:
title: unfollowuserrequest
required:
- followedId
type: object
properties:
followedId:
type: string
example:
followedId: f677f4a7-39dd-419c-aa44-dfc66c26170a
securitySchemes:
httpBearer:
type: http
scheme: bearer
security:
- httpBearer: []
tags:
- name: Auth
- name: Post
- name: Follow
- name: Comment
- name: Like
- name: Reply
- name: Retweet
- name: Image