|
1 | | -from apiflask import APIBlueprint |
2 | | -from flask import g, request |
| 1 | +""" |
| 2 | +Documentation |
| 3 | +""" |
3 | 4 |
|
4 | 5 | import uuid |
5 | 6 | import schema |
6 | 7 | import datetime |
7 | 8 |
|
| 9 | +from apiflask import APIBlueprint |
| 10 | +from flask import g, request |
| 11 | + |
| 12 | + |
8 | 13 | users = APIBlueprint( |
9 | | - "users_blueprint", |
| 14 | + "users", |
10 | 15 | __name__, |
11 | 16 | tag={ |
12 | 17 | "name": "User Management", |
13 | | - "description": "Operations related to management of users (CRUD, Authentication, Authorization)", |
| 18 | + "description": "Operations related to management of users (CRUD, Auth)", |
14 | 19 | }, |
15 | 20 | ) |
16 | 21 |
|
17 | 22 |
|
18 | 23 | @users.before_request |
19 | 24 | def assign_request_id(): |
| 25 | + """ |
| 26 | + This function executes before any request. |
| 27 | + It creates a request uuid and assigns it in the global namespace variable 'g'. |
| 28 | + """ |
20 | 29 | g.request_id = request.headers.get("X-Request-ID", str(uuid.uuid4())) |
21 | 30 |
|
22 | 31 |
|
23 | 32 | @users.after_request |
24 | 33 | def add_request_id_to_response(response): |
| 34 | + """ |
| 35 | + This function executes after any request. |
| 36 | + It puts the uuid created in the 'g' global variable to the response dictionary. |
| 37 | + """ |
25 | 38 | response.headers["X-Request-ID"] = g.request_id |
26 | 39 | return response |
27 | 40 |
|
28 | 41 |
|
29 | 42 | @users.route("/", methods=["GET"]) |
30 | 43 | @users.output(schema.GenericResponse, status_code=200) |
31 | 44 | def api_get_users(): |
32 | | - pass |
| 45 | + """ |
| 46 | + Gets all users. |
| 47 | + """ |
33 | 48 |
|
34 | 49 |
|
35 | 50 | @users.route("/", methods=["POST"]) |
36 | 51 | @users.output(schema.GenericResponse, status_code=200) |
37 | 52 | def api_post_user(): |
38 | | - pass |
| 53 | + """ |
| 54 | + Create a new user. |
| 55 | + """ |
39 | 56 |
|
40 | 57 |
|
41 | 58 | @users.route("/token", methods=["POST"]) |
@@ -77,16 +94,22 @@ def api_post_users_token(json: dict): |
77 | 94 | @users.route("/<user_id>", methods=["GET"]) |
78 | 95 | @users.output(schema.GenericResponse, status_code=200) |
79 | 96 | def api_get_user(): |
80 | | - pass |
| 97 | + """ |
| 98 | + Get an existing user. |
| 99 | + """ |
81 | 100 |
|
82 | 101 |
|
83 | 102 | @users.route("/<user_id>", methods=["PATCH"]) |
84 | 103 | @users.output(schema.GenericResponse, status_code=200) |
85 | 104 | def api_patch_user(): |
86 | | - pass |
| 105 | + """ |
| 106 | + Update an existing user. |
| 107 | + """ |
87 | 108 |
|
88 | 109 |
|
89 | 110 | @users.route("/<user_id>", methods=["DELETE"]) |
90 | 111 | @users.output(schema.GenericResponse, status_code=200) |
91 | 112 | def api_delete_user(): |
92 | | - pass |
| 113 | + """ |
| 114 | + Delete an existing user. |
| 115 | + """ |
0 commit comments