Skip to content

Commit 31a170c

Browse files
authored
docs: fix description messages on swagger (#1047)
* Fixed Description messages on Backend Server * Fixed Description messages on Backend Server
1 parent 2f56538 commit 31a170c

File tree

3 files changed

+51
-20
lines changed

3 files changed

+51
-20
lines changed

app/api/resources/admin.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,16 @@ class ListAdmins(Resource):
8181
@classmethod
8282
@jwt_required
8383
@admin_ns.doc("get_list_of_admins")
84-
@admin_ns.response(HTTPStatus.OK.value, "Success.", public_admin_user_api_model)
84+
@admin_ns.response(
85+
HTTPStatus.OK.value,
86+
f"{messages.GENERAL_SUCCESS_MESSAGE}",
87+
public_admin_user_api_model,
88+
)
8589
@admin_ns.doc(
8690
responses={
87-
HTTPStatus.UNAUTHORIZED.value: f"{messages.TOKEN_HAS_EXPIRED['message']}<br>"
88-
f"{messages.TOKEN_IS_INVALID['message']}<br>"
89-
f"{messages.AUTHORISATION_TOKEN_IS_MISSING['message']}"
91+
HTTPStatus.UNAUTHORIZED.value: f"{messages.TOKEN_HAS_EXPIRED}<br>"
92+
f"{messages.TOKEN_IS_INVALID}<br>"
93+
f"{messages.AUTHORISATION_TOKEN_IS_MISSING}"
9094
}
9195
)
9296
@admin_ns.response(HTTPStatus.FORBIDDEN.value, f"{messages.USER_IS_NOT_AN_ADMIN}")

app/api/resources/user.py

Lines changed: 36 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,16 @@ class UserList(Resource):
4545
"per_page": "specify number of users per page (default: 10)",
4646
},
4747
)
48+
@users_ns.response(
49+
HTTPStatus.OK.value,
50+
f"{messages.GENERAL_SUCCESS_MESSAGE}",
51+
public_user_api_model,
52+
)
4853
@users_ns.doc(
4954
responses={
50-
HTTPStatus.UNAUTHORIZED.value: f"{messages.TOKEN_HAS_EXPIRED['message']}<br>"
51-
f"{messages.TOKEN_IS_INVALID['message']}<br>"
52-
f"{messages.AUTHORISATION_TOKEN_IS_MISSING['message']}"
55+
HTTPStatus.UNAUTHORIZED.value: f"{messages.TOKEN_HAS_EXPIRED}<br>"
56+
f"{messages.TOKEN_IS_INVALID}<br>"
57+
f"{messages.AUTHORISATION_TOKEN_IS_MISSING}"
5358
}
5459
)
5560
@users_ns.marshal_list_with(
@@ -83,7 +88,11 @@ class OtherUser(Resource):
8388
@jwt_required
8489
@users_ns.doc("get_user")
8590
@users_ns.expect(auth_header_parser)
86-
@users_ns.response(HTTPStatus.OK.value, "Success.", public_user_api_model)
91+
@users_ns.response(
92+
HTTPStatus.OK.value,
93+
f"{messages.GENERAL_SUCCESS_MESSAGE}",
94+
public_user_api_model,
95+
)
8796
@users_ns.response(
8897
HTTPStatus.UNAUTHORIZED.value,
8998
"%s\n%s\n%s"
@@ -251,11 +260,16 @@ class VerifiedUser(Resource):
251260
"per_page": "specify number of users per page",
252261
},
253262
)
263+
@users_ns.response(
264+
HTTPStatus.OK.value,
265+
f"{messages.GENERAL_SUCCESS_MESSAGE}",
266+
public_user_api_model,
267+
)
254268
@users_ns.doc(
255269
responses={
256-
HTTPStatus.UNAUTHORIZED.value: f"{messages.TOKEN_HAS_EXPIRED['message']}<br>"
257-
f"{messages.TOKEN_IS_INVALID['message']}<br>"
258-
f"{messages.AUTHORISATION_TOKEN_IS_MISSING['message']}"
270+
HTTPStatus.UNAUTHORIZED.value: f"{messages.TOKEN_HAS_EXPIRED}<br>"
271+
f"{messages.TOKEN_IS_INVALID}<br>"
272+
f"{messages.AUTHORISATION_TOKEN_IS_MISSING}"
259273
}
260274
)
261275
@users_ns.marshal_list_with(
@@ -369,13 +383,13 @@ def get(cls, token):
369383

370384

371385
@users_ns.route("user/resend_email")
372-
@users_ns.response(HTTPStatus.OK.value, "%s" % messages.EMAIL_VERIFICATION_MESSAGE)
373-
@users_ns.response(HTTPStatus.BAD_REQUEST.value, "Invalid input.")
386+
@users_ns.response(HTTPStatus.OK.value, f"{messages.EMAIL_VERIFICATION_MESSAGE}")
387+
@users_ns.response(HTTPStatus.BAD_REQUEST.value, f"{messages.INVALID_INPUT}")
374388
@users_ns.response(
375-
HTTPStatus.FORBIDDEN.value, "%s" % messages.USER_ALREADY_CONFIRMED_ACCOUNT
389+
HTTPStatus.FORBIDDEN.value, f"{messages.USER_ALREADY_CONFIRMED_ACCOUNT}"
376390
)
377391
@users_ns.response(
378-
HTTPStatus.NOT_FOUND.value, "%s" % messages.USER_IS_NOT_REGISTERED_IN_THE_SYSTEM
392+
HTTPStatus.NOT_FOUND.value, f"{messages.USER_IS_NOT_REGISTERED_IN_THE_SYSTEM}"
379393
)
380394
class UserResendEmailConfirmation(Resource):
381395
@classmethod
@@ -413,7 +427,9 @@ class RefreshUser(Resource):
413427
@jwt_refresh_token_required
414428
@users_ns.doc("refresh")
415429
@users_ns.response(
416-
HTTPStatus.OK.value, "Successful refresh", refresh_response_body_model
430+
HTTPStatus.OK.value,
431+
f"{messages.SUCCESSFUL_REFRESH}",
432+
refresh_response_body_model,
417433
)
418434
@users_ns.response(
419435
HTTPStatus.UNAUTHORIZED.value,
@@ -445,7 +461,7 @@ class LoginUser(Resource):
445461
@classmethod
446462
@users_ns.doc("login")
447463
@users_ns.response(
448-
HTTPStatus.OK.value, "Successful login", login_response_body_model
464+
HTTPStatus.OK.value, f"{messages.SUCCESSFUL_LOGIN}", login_response_body_model
449465
)
450466
@users_ns.response(
451467
HTTPStatus.BAD_REQUEST.value,
@@ -506,7 +522,9 @@ def post(cls):
506522
@users_ns.route("home")
507523
@users_ns.doc("home")
508524
@users_ns.expect(auth_header_parser, validate=True)
509-
@users_ns.response(HTTPStatus.OK.value, "Successful response", home_response_body_model)
525+
@users_ns.response(
526+
HTTPStatus.OK.value, f"{messages.SUCCESSFUL_RESPONSE}", home_response_body_model
527+
)
510528
@users_ns.response(
511529
HTTPStatus.UNAUTHORIZED.value,
512530
"%s\n%s\n%s"
@@ -539,9 +557,11 @@ def get(cls):
539557
@users_ns.route("dashboard")
540558
@users_ns.expect(auth_header_parser, validate=True)
541559
@users_ns.response(
542-
HTTPStatus.OK.value, "Successful response", dashboard_response_body_model
560+
HTTPStatus.OK.value,
561+
f"{messages.GENERAL_SUCCESS_MESSAGE}",
562+
dashboard_response_body_model,
543563
)
544-
@users_ns.response(HTTPStatus.NOT_FOUND.value, "User not found")
564+
@users_ns.response(HTTPStatus.NOT_FOUND.value, f"{messages.USER_NOT_FOUND}")
545565
class UserDashboard(Resource):
546566
@classmethod
547567
@jwt_required

app/messages.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
FIELD_AVAILABLE_TO_MENTOR_IS_INVALID = {
1717
"message": "Field available_to_mentor" " is not valid."
1818
}
19+
INVALID_INPUT = {"message": "Invalid input."}
1920
PASSWORD_INPUT_BY_USER_HAS_INVALID_LENGTH = {
2021
"message": f"The password field has to be longer than {PASSWORD_MIN_LENGTH - 1} characters and shorter than {PASSWORD_MAX_LENGTH + 1} characters."
2122
}
@@ -280,7 +281,13 @@
280281
LIST_TASK_COMMENTS_WITH_SUCCESS = {
281282
"message": "List task comments from a mentorship relation with success."
282283
}
284+
GENERAL_SUCCESS_MESSAGE = {"message": "Success."}
283285

286+
SUCCESSFUL_REFRESH = {"message": "Successful refresh."}
287+
288+
SUCCESSFUL_RESPONSE = {"message": "Successful response."}
289+
290+
SUCCESSFUL_LOGIN = {"message": "Successful login"}
284291
# confimation
285292
ACCOUNT_ALREADY_CONFIRMED = {"message": "Account already confirmed."}
286293
USER_ALREADY_CONFIRMED_ACCOUNT = {"message": "You already confirm your email."}

0 commit comments

Comments
 (0)