Skip to content

Commit 35c720f

Browse files
miladrahimimiladrahimi
committed
update route params
1 parent 5d5dbc0 commit 35c720f

File tree

1 file changed

+204
-15
lines changed

1 file changed

+204
-15
lines changed

‎web/swagger.json

+204-15
Original file line numberDiff line numberDiff line change
@@ -561,6 +561,18 @@
561561
"tags": [
562562
"Users"
563563
],
564+
"parameters": [
565+
{
566+
"name": "userId",
567+
"in": "path",
568+
"description": "The ID of user (uint64)",
569+
"required": true,
570+
"schema": {
571+
"type": "integer",
572+
"example": "13"
573+
}
574+
}
575+
],
564576
"responses": {
565577
"200": {
566578
"description": "The user details returned successfully.",
@@ -600,7 +612,20 @@
600612
"get": {
601613
"summary": "Index user followings",
602614
"description": "Index the followings of the user.",
615+
"tags": [
616+
"Users"
617+
],
603618
"parameters": [
619+
{
620+
"name": "userId",
621+
"in": "path",
622+
"description": "The ID of user (uint64)",
623+
"required": true,
624+
"schema": {
625+
"type": "integer",
626+
"example": "13"
627+
}
628+
},
604629
{
605630
"name": "count",
606631
"in": "query",
@@ -615,17 +640,15 @@
615640
{
616641
"name": "lastId",
617642
"in": "query",
618-
"description": "ID of the last item retrieved",
643+
"description": "The ID of the last item retrieved",
619644
"required": false,
620645
"schema": {
621646
"type": "integer",
622-
"example": 13
647+
"example": 13,
648+
"default": null
623649
}
624650
}
625651
],
626-
"tags": [
627-
"Users"
628-
],
629652
"responses": {
630653
"200": {
631654
"description": "List of user followings returned successfully.",
@@ -656,6 +679,16 @@
656679
"Users"
657680
],
658681
"parameters": [
682+
{
683+
"name": "userId",
684+
"in": "path",
685+
"description": "The ID of user (uint64)",
686+
"required": true,
687+
"schema": {
688+
"type": "integer",
689+
"example": "13"
690+
}
691+
},
659692
{
660693
"name": "count",
661694
"in": "query",
@@ -670,11 +703,12 @@
670703
{
671704
"name": "lastId",
672705
"in": "query",
673-
"description": "ID of the last item retrieved",
706+
"description": "The ID of the last item retrieved",
674707
"required": false,
675708
"schema": {
676709
"type": "integer",
677-
"example": 13
710+
"example": 13,
711+
"default": null
678712
}
679713
}
680714
],
@@ -705,6 +739,18 @@
705739
"tags": [
706740
"Users"
707741
],
742+
"parameters": [
743+
{
744+
"name": "userId",
745+
"in": "path",
746+
"description": "The ID of user (uint64)",
747+
"required": true,
748+
"schema": {
749+
"type": "integer",
750+
"example": "13"
751+
}
752+
}
753+
],
708754
"responses": {
709755
"201": {
710756
"description": "The user followed successfully."
@@ -717,6 +763,18 @@
717763
"tags": [
718764
"Users"
719765
],
766+
"parameters": [
767+
{
768+
"name": "userId",
769+
"in": "path",
770+
"description": "The ID of user (uint64)",
771+
"required": true,
772+
"schema": {
773+
"type": "integer",
774+
"example": "13"
775+
}
776+
}
777+
],
720778
"responses": {
721779
"204": {
722780
"description": "The user unfollowed successfully."
@@ -731,6 +789,40 @@
731789
"tags": [
732790
"Posts"
733791
],
792+
"parameters": [
793+
{
794+
"name": "userId",
795+
"in": "path",
796+
"description": "The ID of user (uint64)",
797+
"required": true,
798+
"schema": {
799+
"type": "integer",
800+
"example": "13"
801+
}
802+
},
803+
{
804+
"name": "count",
805+
"in": "query",
806+
"description": "Number of items to retrieve",
807+
"required": false,
808+
"schema": {
809+
"type": "integer",
810+
"example": 5,
811+
"default": 10
812+
}
813+
},
814+
{
815+
"name": "lastId",
816+
"in": "query",
817+
"description": "The ID of the last item retrieved",
818+
"required": false,
819+
"schema": {
820+
"type": "integer",
821+
"example": 13,
822+
"default": null
823+
}
824+
}
825+
],
734826
"responses": {
735827
"200": {
736828
"description": "List of the user posts returned successfully.",
@@ -796,6 +888,18 @@
796888
"tags": [
797889
"Posts"
798890
],
891+
"parameters": [
892+
{
893+
"name": "postId",
894+
"in": "path",
895+
"description": "The ID of post (uint64)",
896+
"required": true,
897+
"schema": {
898+
"type": "integer",
899+
"example": "13"
900+
}
901+
}
902+
],
799903
"responses": {
800904
"201": {
801905
"description": "The post returned successfully.",
@@ -820,6 +924,18 @@
820924
"tags": [
821925
"Posts"
822926
],
927+
"parameters": [
928+
{
929+
"name": "postId",
930+
"in": "path",
931+
"description": "The ID of post (uint64)",
932+
"required": true,
933+
"schema": {
934+
"type": "integer",
935+
"example": "13"
936+
}
937+
}
938+
],
823939
"requestBody": {
824940
"required": true,
825941
"content": {
@@ -866,6 +982,18 @@
866982
"tags": [
867983
"Posts"
868984
],
985+
"parameters": [
986+
{
987+
"name": "postId",
988+
"in": "path",
989+
"description": "The ID of post (uint64)",
990+
"required": true,
991+
"schema": {
992+
"type": "integer",
993+
"example": "13"
994+
}
995+
}
996+
],
869997
"responses": {
870998
"204": {
871999
"description": "The post deleted successfully."
@@ -881,6 +1009,16 @@
8811009
"Likes"
8821010
],
8831011
"parameters": [
1012+
{
1013+
"name": "postId",
1014+
"in": "path",
1015+
"description": "The ID of post (uint64)",
1016+
"required": true,
1017+
"schema": {
1018+
"type": "integer",
1019+
"example": "13"
1020+
}
1021+
},
8841022
{
8851023
"name": "count",
8861024
"in": "query",
@@ -899,7 +1037,8 @@
8991037
"required": false,
9001038
"schema": {
9011039
"type": "integer",
902-
"example": 13
1040+
"example": 13,
1041+
"default": null
9031042
}
9041043
}
9051044
],
@@ -930,6 +1069,18 @@
9301069
"tags": [
9311070
"Likes"
9321071
],
1072+
"parameters": [
1073+
{
1074+
"name": "postId",
1075+
"in": "path",
1076+
"description": "The ID of post (uint64)",
1077+
"required": true,
1078+
"schema": {
1079+
"type": "integer",
1080+
"example": "13"
1081+
}
1082+
}
1083+
],
9331084
"responses": {
9341085
"201": {
9351086
"description": "The post liked successfully."
@@ -944,6 +1095,18 @@
9441095
"tags": [
9451096
"Likes"
9461097
],
1098+
"parameters": [
1099+
{
1100+
"name": "likeId",
1101+
"in": "path",
1102+
"description": "The ID of like (uint64)",
1103+
"required": true,
1104+
"schema": {
1105+
"type": "integer",
1106+
"example": "13"
1107+
}
1108+
}
1109+
],
9471110
"responses": {
9481111
"201": {
9491112
"description": "The like deleted successfully."
@@ -959,6 +1122,16 @@
9591122
"Comments"
9601123
],
9611124
"parameters": [
1125+
{
1126+
"name": "postId",
1127+
"in": "path",
1128+
"description": "The ID of post (uint64)",
1129+
"required": true,
1130+
"schema": {
1131+
"type": "integer",
1132+
"example": "13"
1133+
}
1134+
},
9621135
{
9631136
"name": "count",
9641137
"in": "query",
@@ -977,7 +1150,8 @@
9771150
"required": false,
9781151
"schema": {
9791152
"type": "integer",
980-
"example": 13
1153+
"example": 13,
1154+
"default": null
9811155
}
9821156
}
9831157
],
@@ -1029,7 +1203,8 @@
10291203
"required": false,
10301204
"schema": {
10311205
"type": "integer",
1032-
"example": 13
1206+
"example": 13,
1207+
"default": null
10331208
}
10341209
}
10351210
],
@@ -1084,6 +1259,18 @@
10841259
"tags": [
10851260
"Comments"
10861261
],
1262+
"parameters": [
1263+
{
1264+
"name": "commentId",
1265+
"in": "path",
1266+
"description": "The ID of comment (uint64)",
1267+
"required": true,
1268+
"schema": {
1269+
"type": "integer",
1270+
"example": "13"
1271+
}
1272+
}
1273+
],
10871274
"responses": {
10881275
"204": {
10891276
"description": "The comment deleted successfully."
@@ -1128,7 +1315,8 @@
11281315
"required": false,
11291316
"schema": {
11301317
"type": "integer",
1131-
"example": 13
1318+
"example": 13,
1319+
"default": null
11321320
}
11331321
}
11341322
],
@@ -1169,8 +1357,7 @@
11691357
"required": true,
11701358
"schema": {
11711359
"type": "string",
1172-
"example": "Milad Rahimi",
1173-
"description": "The search query"
1360+
"example": "Milad Rahimi"
11741361
}
11751362
},
11761363
{
@@ -1191,7 +1378,8 @@
11911378
"required": false,
11921379
"schema": {
11931380
"type": "integer",
1194-
"example": 13
1381+
"example": 13,
1382+
"default": null
11951383
}
11961384
}
11971385
],
@@ -1243,7 +1431,8 @@
12431431
"required": false,
12441432
"schema": {
12451433
"type": "integer",
1246-
"example": 13
1434+
"example": 13,
1435+
"default": null
12471436
}
12481437
}
12491438
],

0 commit comments

Comments
 (0)