Rename endpoints to be more descriptive

Author: jehua-tech

gs/backend/api/v1/aro/endpoints/user.py

@@ -3,29 +3,29 @@
 from fastapi import APIRouter, HTTPException
 
 from gs.backend.api.v1.aro.models.requests import UserRequest
-from gs.backend.api.v1.aro.models.responses import UserResponse, UsersResponse
+from gs.backend.api.v1.aro.models.responses import AllUsersResponse, UserResponse
 from gs.backend.data.data_wrappers.aro_wrapper.aro_user_data_wrapper import (
     add_user,
     delete_user_by_id,
-    get_all_users,
     update_user_by_id,
 )
+from gs.backend.data.data_wrappers.aro_wrapper.aro_user_data_wrapper import get_all_users as get_all_db_users
 
 aro_user_router = APIRouter(tags=["ARO", "User Information"])
 
 
-@aro_user_router.get("/", response_model=UsersResponse)
-async def get_users() -> UsersResponse:
+@aro_user_router.get("/get_all_users", response_model=AllUsersResponse)
+async def get_all_users() -> AllUsersResponse:
     """
     Gets all users
 
     :return: all users
     """
-    users = get_all_users()
-    return UsersResponse(data=users)
+    users = get_all_db_users()
+    return AllUsersResponse(data=users)
 
 
-@aro_user_router.post("/", response_model=UserResponse)
+@aro_user_router.post("/create_user", response_model=UserResponse)
 def create_user(payload: UserRequest) -> UserResponse:
     """
     Creates a user with the given payload
@@ -44,7 +44,7 @@ def create_user(payload: UserRequest) -> UserResponse:
     return UserResponse(data=user)
 
 
-@aro_user_router.put("/{userid}", response_model=UserResponse)
+@aro_user_router.put("/update_user/{userid}", response_model=UserResponse)
 def update_user(userid: str, payload: UserRequest) -> UserResponse:
     """
     Modifies the user’s info based on the payload
@@ -65,15 +65,15 @@ def update_user(userid: str, payload: UserRequest) -> UserResponse:
         raise HTTPException(status_code=404, detail=str(e)) from e
 
 
-@aro_user_router.delete("/{userid}", response_model=UsersResponse)
-def delete_user(userid: str) -> UsersResponse:
+@aro_user_router.delete("/delete_user/{userid}", response_model=AllUsersResponse)
+def delete_user(userid: str) -> AllUsersResponse:
     """
     Deletes a user based on the user ID
     :param userid: The unique identifier of the user to be deleted
     :return: returns the user deleted
     """
     try:
         users = delete_user_by_id(UUID(userid))
-        return UsersResponse(data=users)
+        return AllUsersResponse(data=users)
     except ValueError as e:
         raise HTTPException(status_code=404, detail=str(e)) from e

gs/backend/api/v1/aro/models/responses.py

@@ -3,7 +3,7 @@
 from gs.backend.data.tables.aro_user_tables import AROUsers
 
 
-class UsersResponse(BaseModel):
+class AllUsersResponse(BaseModel):
     """
     The users response model.
     """

python_test/test_aro_user_api.py

@@ -35,7 +35,9 @@ def user2_data():
 # Test creating user1
 @pytest.fixture
 def test_user1_creation(client, user1_data):
-    response = client.post("/api/v1/aro/user/", json=user1_data, headers={"Content-Type": "application/json"})
+    response = client.post(
+        "/api/v1/aro/user/create_user", json=user1_data, headers={"Content-Type": "application/json"}
+    )
 
     assert response.status_code == 200
     user = response.json()["data"]
@@ -51,7 +53,9 @@ def test_user1_creation(client, user1_data):
 # Test creating user2
 @pytest.fixture
 def test_user2_creation(client, user2_data):
-    response = client.post("/api/v1/aro/user/", json=user2_data, headers={"Content-Type": "application/json"})
+    response = client.post(
+        "/api/v1/aro/user/create_user", json=user2_data, headers={"Content-Type": "application/json"}
+    )
 
     assert response.status_code == 200
     user = response.json()["data"]
@@ -75,7 +79,9 @@ def test_user1_update(client, test_user1_creation):
         "last_name": "Smith",
         "phone_number": "234567890",
     }
-    res = client.put(f"/api/v1/aro/user/{user_id}", json=update_data, headers={"Content-Type": "application/json"})
+    res = client.put(
+        f"/api/v1/aro/user/update_user/{user_id}", json=update_data, headers={"Content-Type": "application/json"}
+    )
 
     assert res.status_code == 200
     updated_user = res.json()["data"]
@@ -91,7 +97,7 @@ def test_user1_update(client, test_user1_creation):
 # Test getting all users (after creating user1 and user2, and updating user1 to ensure creation and update work oncorrect user objects)
 @pytest.fixture
 def test_get_users(client, test_user1_update, test_user2_creation):
-    res = client.get("/api/v1/aro/user/")
+    res = client.get("/api/v1/aro/user/get_all_users")
 
     assert res.status_code == 200
     all_users = res.json()["data"]
@@ -119,7 +125,7 @@ def test_get_users(client, test_user1_update, test_user2_creation):
 # Test deleting user1 (after test_get_users to ensure both users exist)
 def test_user1_deletion(client, test_user1_update, test_user2_creation, test_get_users):
     user_id = test_user1_update["id"]
-    res = client.delete(f"/api/v1/aro/user/{user_id}", headers={"Content-Type": "application/json"})
+    res = client.delete(f"/api/v1/aro/user/delete_user/{user_id}", headers={"Content-Type": "application/json"})
 
     assert res.status_code == 200
     all_users = res.json()["data"]