Merge pull request #12 from JaneliaSciComp/proxied-path-response

Wrap user proxied paths in an object instead of returning a list

Author: cgoina

fileglancer_central/app.py

@@ -11,7 +11,7 @@
 from fastapi.exceptions import RequestValidationError, StarletteHTTPException
 
 from fileglancer_central import database as db
-from fileglancer_central.model import FileSharePath, FileSharePathResponse, Ticket, ProxiedPath
+from fileglancer_central.model import FileSharePath, FileSharePathResponse, Ticket, ProxiedPath, ProxiedPathResponse
 from fileglancer_central.settings import get_settings
 from fileglancer_central.wiki import get_wiki_table, convert_table_to_file_share_paths
 from fileglancer_central.issues import create_jira_ticket, get_jira_ticket_details, delete_jira_ticket
@@ -247,11 +247,18 @@ async def create_proxied_path(username: str = Path(..., description="The usernam
             )
 
 
-    @app.get("/proxied-path/{username}", response_model=List[ProxiedPath],
+    @app.get("/proxied-path/{username}", response_model=ProxiedPathResponse,
              description="Retrieve all proxied paths for a user")
     async def get_proxied_paths(username: str = Path(..., description="The username of the user who owns the proxied paths")):
         with db.get_db_session() as session:
-            return db.get_all_proxied_paths(session, username)
+            db_proxied_paths = db.get_all_proxied_paths(session, username)
+            proxied_paths = [ProxiedPath(
+                username=db_proxied_path.username,
+                sharing_key=db_proxied_path.sharing_key,
+                sharing_name=db_proxied_path.sharing_name,
+                mount_path=db_proxied_path.mount_path
+            ) for db_proxied_path in db_proxied_paths]
+            return ProxiedPathResponse(paths=proxied_paths)
 
 
     @app.get("/proxied-path/{username}/{sharing_key}", response_model=ProxiedPath,

fileglancer_central/model.py

@@ -108,6 +108,7 @@ class UserPreference(BaseModel):
         description="The value of the preference"
     )
 
+
 class ProxiedPath(BaseModel):
     """A proxied path which is used to share a file system path via a URL"""
     username: str = Field(
@@ -122,3 +123,9 @@ class ProxiedPath(BaseModel):
     mount_path: str = Field(
         description="The root path on the file system to be proxied"
     )
+
+
+class ProxiedPathResponse(BaseModel):
+    paths: List[ProxiedPath] = Field(
+        description="A list of proxied paths"
+    )

tests/test_endpoints.py

@@ -102,8 +102,10 @@ def test_get_proxied_paths(test_client, temp_dir):
     response = test_client.get(f"/proxied-path/testuser")
     assert response.status_code == 200
     data = response.json()
-    assert isinstance(data, list)
-    assert len(data) > 1
+    assert isinstance(data, dict)
+    assert "paths" in data
+    assert isinstance(data["paths"], list)
+    assert len(data["paths"]) > 1
 
 
 def test_update_proxied_path(test_client, temp_dir):