Skip to content

Commit 41ac2ed

Browse files
miladrahimimiladrahimi
committed
update summaries
1 parent 16ffc21 commit 41ac2ed

File tree

1 file changed

+66
-33
lines changed

1 file changed

+66
-33
lines changed

‎web/swagger.json

+66-33
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
"paths": {
1414
"/auth/otp/email/generate": {
1515
"post": {
16-
"summary": "Generate OTP in order to sign up or sign in.",
16+
"summary": "Generate and send OTP",
17+
"description": "Generate and send OTP using email in order to sign up or sign in.",
1718
"tags": [
1819
"Auth"
1920
],
@@ -59,7 +60,8 @@
5960
},
6061
"/auth/otp/email/submit": {
6162
"post": {
62-
"summary": "Submit OTP received by email to complete sign in or sign up process.",
63+
"summary": "Submit OTP",
64+
"description": "Submit OTP received by email to complete sign in or sign up process.",
6365
"tags": [
6466
"Auth"
6567
],
@@ -114,7 +116,8 @@
114116
},
115117
"/auth/sign-in/email": {
116118
"post": {
117-
"summary": "Sign in by email and password.",
119+
"summary": "Sign in by email",
120+
"description": "Sign in by email and password.",
118121
"tags": [
119122
"Auth"
120123
],
@@ -167,7 +170,8 @@
167170
},
168171
"/auth/sign-in/username": {
169172
"post": {
170-
"summary": "Sign in by username and password.",
173+
"summary": "Sign in by username",
174+
"description": "Sign in by username and password.",
171175
"tags": [
172176
"Auth"
173177
],
@@ -220,7 +224,8 @@
220224
},
221225
"/auth/sign-in/google": {
222226
"post": {
223-
"summary": "Sign in or sign up using Google SSO.",
227+
"summary": "Sign in/up using Google",
228+
"description": "Sign in or sign up using Google SSO (Single Sign On).",
224229
"tags": [
225230
"Auth"
226231
],
@@ -269,7 +274,8 @@
269274
},
270275
"/profile": {
271276
"get": {
272-
"summary": "Get my profile.",
277+
"summary": "Get profile",
278+
"description": "Get my profile details.",
273279
"tags": [
274280
"Profile"
275281
],
@@ -300,7 +306,8 @@
300306
}
301307
},
302308
"delete": {
303-
"summary": "Submit delete account request.",
309+
"summary": "Delete account",
310+
"description": "Submit delete account request for my account.",
304311
"tags": [
305312
"Profile"
306313
],
@@ -313,7 +320,8 @@
313320
},
314321
"/profile/name": {
315322
"patch": {
316-
"summary": "Update my name.",
323+
"summary": "Update name",
324+
"description": "Update my name.",
317325
"tags": [
318326
"Profile"
319327
],
@@ -358,7 +366,8 @@
358366
},
359367
"/profile/bio": {
360368
"patch": {
361-
"summary": "Update my bio.",
369+
"summary": "Update bio",
370+
"description": "Update my bio (biography).",
362371
"tags": [
363372
"Profile"
364373
],
@@ -403,7 +412,8 @@
403412
},
404413
"/profile/username": {
405414
"patch": {
406-
"summary": "Update my username.",
415+
"summary": "Update username",
416+
"description": "Update my username.",
407417
"tags": [
408418
"Profile"
409419
],
@@ -420,7 +430,8 @@
420430
"username": {
421431
"type": "string",
422432
"example": "jack",
423-
"description": "The new username"
433+
"description": "The new username (format: ^[a-z0-9_]+$)",
434+
"format": "^[a-z0-9_]+$"
424435
}
425436
}
426437
}
@@ -448,7 +459,8 @@
448459
},
449460
"/profile/image": {
450461
"patch": {
451-
"summary": "Update my image (photo).",
462+
"summary": "Update image",
463+
"description": "Update (upload) my image (photo).",
452464
"tags": [
453465
"Profile"
454466
],
@@ -494,7 +506,8 @@
494506
},
495507
"/files": {
496508
"post": {
497-
"summary": "Upload a new file.",
509+
"summary": "Upload file",
510+
"description": "Upload a new file.",
498511
"tags": [
499512
"Files"
500513
],
@@ -543,7 +556,8 @@
543556
},
544557
"/users/{userId}": {
545558
"get": {
546-
"summary": "Get the user details.",
559+
"summary": "Get user",
560+
"description": "Get the user.",
547561
"tags": [
548562
"Users"
549563
],
@@ -584,7 +598,8 @@
584598
},
585599
"/users/{userId}/followings": {
586600
"get": {
587-
"summary": "Index followings of the user.",
601+
"summary": "Index user followings",
602+
"description": "Index the followings of the user.",
588603
"parameters": [
589604
{
590605
"name": "count",
@@ -635,7 +650,8 @@
635650
},
636651
"/users/{userId}/followers": {
637652
"get": {
638-
"summary": "Index followers of the user.",
653+
"summary": "Index user followers",
654+
"description": "Index the followers of the user.",
639655
"tags": [
640656
"Users"
641657
],
@@ -684,7 +700,8 @@
684700
}
685701
},
686702
"post": {
687-
"summary": "Follow the user.",
703+
"summary": "Follow user",
704+
"description": "Follow the user (submit myself as the user follower).",
688705
"tags": [
689706
"Users"
690707
],
@@ -695,7 +712,8 @@
695712
}
696713
},
697714
"delete": {
698-
"summary": "Unfollow the user.",
715+
"summary": "Unfollow user",
716+
"description": "Unfollow the user (delete myself from the user followers).",
699717
"tags": [
700718
"Users"
701719
],
@@ -708,7 +726,8 @@
708726
},
709727
"/users/{userId}/posts": {
710728
"get": {
711-
"summary": "Index the user posts.",
729+
"summary": "Index user posts",
730+
"description": "Index the posts of the user.",
712731
"tags": [
713732
"Posts"
714733
],
@@ -736,7 +755,8 @@
736755
},
737756
"/posts": {
738757
"post": {
739-
"summary": "Create a new post.",
758+
"summary": "Create post",
759+
"description": "Create a new post.",
740760
"tags": [
741761
"Posts"
742762
],
@@ -771,7 +791,8 @@
771791
},
772792
"/posts/{postId}": {
773793
"get": {
774-
"summary": "Get the post.",
794+
"summary": "Get post",
795+
"description": "Get the post.",
775796
"tags": [
776797
"Posts"
777798
],
@@ -794,7 +815,8 @@
794815
}
795816
},
796817
"put": {
797-
"summary": "Update the post.",
818+
"summary": "Update post",
819+
"description": "Update the post.",
798820
"tags": [
799821
"Posts"
800822
],
@@ -839,7 +861,8 @@
839861
}
840862
},
841863
"delete": {
842-
"summary": "Delete the post.",
864+
"summary": "Delete post",
865+
"description": "Delete the post.",
843866
"tags": [
844867
"Posts"
845868
],
@@ -852,7 +875,8 @@
852875
},
853876
"/posts/{postId}/likes": {
854877
"get": {
855-
"summary": "Index the post likes.",
878+
"summary": "Index post likes",
879+
"description": "Index the likes of the post.",
856880
"tags": [
857881
"Likes"
858882
],
@@ -901,7 +925,8 @@
901925
}
902926
},
903927
"post": {
904-
"summary": "Like the post.",
928+
"summary": "Like post",
929+
"description": "Like the post (create like for the post).",
905930
"tags": [
906931
"Likes"
907932
],
@@ -914,7 +939,8 @@
914939
},
915940
"/likes/{likeId}": {
916941
"delete": {
917-
"summary": "Delete the like (unlike related post).",
942+
"summary": "Unlike",
943+
"description": "Delete the like (unlike related post).",
918944
"tags": [
919945
"Likes"
920946
],
@@ -927,7 +953,8 @@
927953
},
928954
"/posts/{postId}/comments": {
929955
"get": {
930-
"summary": "Index the post comments.",
956+
"summary": "Index post comments",
957+
"description": "Index the comments of the post.",
931958
"tags": [
932959
"Comments"
933960
],
@@ -978,7 +1005,8 @@
9781005
},
9791006
"/comments": {
9801007
"get": {
981-
"summary": "Index my comments.",
1008+
"summary": "Index my comments",
1009+
"description": "Index all of my comments.",
9821010
"tags": [
9831011
"Comments"
9841012
],
@@ -1027,7 +1055,8 @@
10271055
}
10281056
},
10291057
"post": {
1030-
"summary": "Create a new comment.",
1058+
"summary": "Create comment",
1059+
"description": "Create a new comment.",
10311060
"tags": [
10321061
"Comments"
10331062
],
@@ -1050,7 +1079,8 @@
10501079
},
10511080
"/comments/{commentId}": {
10521081
"delete": {
1053-
"summary": "Delete the comment (my comment or my post's comment).",
1082+
"summary": "Delete comment",
1083+
"description": "Delete the comment (either my comment or a comment on one of my posts).",
10541084
"tags": [
10551085
"Comments"
10561086
],
@@ -1063,7 +1093,8 @@
10631093
},
10641094
"/search/posts": {
10651095
"get": {
1066-
"summary": "Search in posts.",
1096+
"summary": "Search posts",
1097+
"description": "Search in all posts.",
10671098
"tags": [
10681099
"Search"
10691100
],
@@ -1125,7 +1156,8 @@
11251156
},
11261157
"/search/users": {
11271158
"get": {
1128-
"summary": "Search in users.",
1159+
"summary": "Search users",
1160+
"description": "Search in all users.",
11291161
"tags": [
11301162
"Search"
11311163
],
@@ -1187,7 +1219,8 @@
11871219
},
11881220
"/feed": {
11891221
"get": {
1190-
"summary": "Index my feed posts.",
1222+
"summary": "Index feed posts",
1223+
"description": "Index my feed posts.",
11911224
"tags": [
11921225
"Feed"
11931226
],

0 commit comments

Comments
 (0)