Skip to content

Commit b4f6281

Browse files
Update API swagger definition sumary and respones description.
1 parent 7b63c71 commit b4f6281

File tree

5 files changed

+38
-55
lines changed

5 files changed

+38
-55
lines changed

src/swagger/admin.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/admin/signin:
22
post:
3-
summary: Sign In
3+
summary: Sign in
44
tags:
55
- Admin
66
requestBody:
@@ -27,7 +27,7 @@
2727

2828
/admin/signout:
2929
post:
30-
summary: Sign Out
30+
summary: Sign out
3131
tags:
3232
- Admin
3333
responses:
@@ -49,7 +49,7 @@
4949

5050
/admin/delete-users:
5151
post:
52-
summary: Delete user
52+
summary: Delete users
5353
tags:
5454
- Admin
5555
requestBody:

src/swagger/auth.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/auth/signup:
22
post:
3-
summary: Sign Up
3+
summary: Sign up
44
tags:
55
- Authentication
66
requestBody:
@@ -39,7 +39,7 @@
3939

4040
/auth/signin:
4141
post:
42-
summary: Sign In
42+
summary: Sign in
4343
tags:
4444
- Authentication
4545
requestBody:
@@ -68,7 +68,7 @@
6868

6969
/auth/signout:
7070
post:
71-
summary: Sign Out
71+
summary: Sign out
7272
tags:
7373
- Authentication
7474
responses:

src/swagger/display.yaml

Lines changed: 27 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2,51 +2,47 @@
22
get:
33
summary: Get top 10 reducing coins and tokens
44
tags:
5-
- Coin-Token
5+
- Coin - Token
66
responses:
77
200:
88
description: Get top 10 reducing coins and tokens successfully
9-
400:
10-
description: Get top 10 reducing coins and tokens failed
9+
# 400: description: Get top 10 reducing coins and tokens failed
1110

1211
/display/coins-and-tokens/all:
1312
get:
1413
summary: Get list of coins
1514
tags:
16-
- Coin-Token
15+
- Coin - Token
1716
responses:
1817
200:
1918
description: Get list of coins successfully
20-
400:
21-
description: Get list of coins failed
19+
# 400: description: Get list of coins failed
2220

2321
/display/coins/trending:
2422
get:
2523
summary: Get top 10 trending coins
2624
tags:
27-
- Coin-Token
25+
- Coin - Token
2826
responses:
2927
200:
3028
description: Get top 10 trending coins successfully
31-
400:
32-
description: Get top 10 trending coins failed
29+
# 400: description: Get top 10 trending coins failed
3330

3431
/display/tokens/trending:
3532
get:
3633
summary: Get top 10 trending tokens
3734
tags:
38-
- Coin-Token
35+
- Coin - Token
3936
responses:
4037
200:
4138
description: Get top 10 trending tokens successfully
42-
400:
43-
description: Get top 10 trending tokens failed
39+
# 400: description: Get top 10 trending tokens failed
4440

4541
/display/coin/details:
4642
get:
4743
summary: Get coin or token details
4844
tags:
49-
- Coin-Token
45+
- Coin - Token
5046
parameters:
5147
- in: query
5248
name: symbol
@@ -55,8 +51,7 @@
5551
responses:
5652
200:
5753
description: Get coin or token details successfully
58-
400:
59-
description: Get coin or token details failed
54+
# 400: description: Get coin or token details failed
6055

6156
/display/sharks:
6257
get:
@@ -71,12 +66,11 @@
7166
responses:
7267
200:
7368
description: Get list of sharks successfully
74-
400:
75-
description: Get list of sharks failed
69+
# 400: description: Get list of sharks failed
7670

7771
/display/sharks/transaction-history/page-length:
7872
post:
79-
summary: Get the length of list transactions
73+
summary: Get length of list transactions
8074
tags:
8175
- Shark
8276
requestBody:
@@ -93,9 +87,8 @@
9387
valueFilter: "10"
9488
responses:
9589
200:
96-
description: Get the length of list transactions successfully
97-
400:
98-
description: Get the length of list transactions failed
90+
description: Get length of list transactions successfully
91+
# 400: description: Get length of list transactions failed
9992

10093
/display/sharks/transaction-history:
10194
post:
@@ -121,8 +114,7 @@
121114
responses:
122115
200:
123116
description: Get list transactions history of all sharks successfully
124-
400:
125-
description: Get list transactions history of all sharks failed
117+
# 400: description: Get list transactions history of all sharks failed
126118

127119
/display/shark/crypto:
128120
get:
@@ -137,12 +129,11 @@
137129
responses:
138130
200:
139131
description: Get list of coin and token of shark successful
140-
400:
141-
description: Get list of coin and token of shark failed
132+
# 400: description: Get list of coin and token of shark failed
142133

143134
/display/shark/transaction-history:
144135
get:
145-
summary: Get the transaction history of shark
136+
summary: Get transaction history of shark
146137
tags:
147138
- Shark
148139
parameters:
@@ -153,8 +144,7 @@
153144
responses:
154145
200:
155146
description: Get transaction history of shark successful
156-
400:
157-
description: Get transaction history of shark failed
147+
# 400: description: Get transaction history of shark failed
158148

159149
/display/shark/trade-transaction-history:
160150
get:
@@ -173,8 +163,7 @@
173163
responses:
174164
200:
175165
description: Get trade coin transaction history successful
176-
400:
177-
description: Get trade coin transaction history failed
166+
# 400: description: Get trade coin transaction history failed
178167

179168
/display/sharks/length:
180169
get:
@@ -184,8 +173,7 @@
184173
responses:
185174
200:
186175
description: Get length of sharks list successful
187-
400:
188-
description: Get length of sharks list failed
176+
# 400: description: Get length of sharks list failed
189177

190178
/display/sharks/transaction-history/length:
191179
get:
@@ -195,14 +183,13 @@
195183
responses:
196184
200:
197185
description: Get length of transactions list successful
198-
400:
199-
description: Get length of transactions list failed
186+
# 400: description: Get length of transactions list failed
200187

201188
/display/sharks/gain-loss:
202189
get:
203190
summary: Get list gain and loss of sharks
204191
tags:
205-
- GainAndLoss
192+
- Gain - Loss
206193
parameters:
207194
- in: query
208195
name: isLoss
@@ -211,14 +198,13 @@
211198
responses:
212199
200:
213200
description: Get list gain and loss of sharks successfully
214-
400:
215-
description: Get list gain and loss of sharks failed
201+
# 400: description: Get list gain and loss of sharks failed
216202

217203
/display/coins/gain-loss:
218204
get:
219205
summary: Get list gain and loss of coins
220206
tags:
221-
- GainAndLoss
207+
- Gain - Loss
222208
parameters:
223209
- in: query
224210
name: isLoss
@@ -227,8 +213,7 @@
227213
responses:
228214
200:
229215
description: Get list gain and loss of coins successfully
230-
400:
231-
description: Get list gain and loss of coins failed
216+
# 400: description: Get list gain and loss of coins failed
232217

233218
/display/users/length:
234219
get:
@@ -238,8 +223,7 @@
238223
responses:
239224
200:
240225
description: Get length of users list successful
241-
400:
242-
description: Get length of users list failed
226+
# 400: description: Get length of users list failed
243227

244228
/display/tags:
245229
get:
@@ -249,5 +233,4 @@
249233
responses:
250234
200:
251235
description: Get list of tags successfully
252-
400:
253-
description: Get list of tags failed
236+
# 400: description: Get list of tags failed

src/swagger/forgotPassword.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/forgot-password/submit-email:
22
post:
3-
summary: Submit Email
3+
summary: Submit email
44
tags:
55
- Forgot Password
66
requestBody:
@@ -25,7 +25,7 @@
2525

2626
/forgot-password/submit-code:
2727
post:
28-
summary: Submit Code
28+
summary: Submit code
2929
tags:
3030
- Forgot Password
3131
requestBody:
@@ -52,7 +52,7 @@
5252

5353
/forgot-password/resend-code:
5454
post:
55-
summary: Resend Code
55+
summary: Resend code
5656
tags:
5757
- Forgot Password
5858
requestBody:
@@ -75,7 +75,7 @@
7575

7676
/forgot-password/create-new-password:
7777
post:
78-
summary: Create New Password
78+
summary: Create new password
7979
tags:
8080
- Forgot Password
8181
requestBody:

src/swagger/user.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060

6161
/user/change-password:
6262
post:
63-
summary: Change Password
63+
summary: Change password
6464
tags:
6565
- User
6666
requestBody:

0 commit comments

Comments
 (0)