proiect finalizat

messenger_app/api/v1/endpoints/users/__init__.py

@@ -5,6 +5,10 @@ from .update import update_user
 from .delete import delete_user
 from .get_all import get_all_users
 
+'''
+The 'messages' packages contains the router configuration for the 'Messages' endpoints.
+'''
+
 router = APIRouter()
 
 

messenger_app/api/v1/endpoints/users/create.py

@@ -4,6 +4,15 @@ from database.queries.user import get_user_by_email, create_user_db
 
 
 async def create_user(user: User):
+    """
+        Creates a user
+
+        Args:
+            user (User)
+
+        Returns:
+            complete user information, including id, if successful
+    """
     result = get_user_by_email(user.email)
     if result:
         raise HTTPException(status_code=409, detail='User already exists.')

messenger_app/api/v1/endpoints/users/delete.py

@@ -2,7 +2,16 @@ from fastapi import HTTPException
 from database.queries.user import get_user_by_id, delete_user_db
 
 
-async def delete_user(user_id: int):
+async def delete_user(user_id):
+    """
+        Deletes a user
+
+        Args:
+            user_id (str)
+
+        Returns:
+            complete user information, including id, if successful
+        """
     user = get_user_by_id(user_id)
     if user is None:
         raise HTTPException(status_code=404, detail='User not found')

messenger_app/api/v1/endpoints/users/get_all.py

@@ -3,4 +3,13 @@ from database.queries.user import get_all_users_db
 
 async def get_all_users():
     users = get_all_users_db()
+    """
+            Gets all users from database
+
+            Args:
+                Nan
+
+            Returns:
+                A list of users, if exists
+        """
     return users