proiect finalizat

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

@@ -6,6 +6,10 @@ from .signup import signup
 
 router = APIRouter()
 
+"""
+The 'auth' packages contains the router configuration for the 'Authentication' endpoints.
+"""
+
 
 @router.post("/login")
 async def login_router(login_info: Login):

messenger_app/api/v1/endpoints/auth/login.py

@@ -4,6 +4,15 @@ from database.queries.user import get_user_by_email
 
 
 async def login(login_info: Login):
+    """
+        Verify user credentials
+
+        Args:
+            login_info (Login)
+
+        Returns:
+            dict : full user information besides password
+    """
     result = get_user_by_email(login_info.email)
     if not result:
         raise HTTPException(status_code=404, detail='User not in system.')

messenger_app/api/v1/endpoints/auth/signup.py

@@ -4,6 +4,15 @@ from database.queries.user import get_user_by_email, create_user_db
 
 
 async def signup(user: User):
+    """
+        Verify user credentials
+
+        Args:
+            user (User)
+
+        Returns:
+             dict : full user information besides password
+        """
     result = get_user_by_email(user.email)
     if result:
         raise HTTPException(status_code=409, detail='User already exists.')