refactor

Author: sanderegg

api/specs/storage/openapi.py

@@ -91,10 +91,10 @@
     f"/{API_VTAG}/locations/{{location_id}}/datasets",
     response_model=Envelope[list[DatasetMetaData]],
     tags=TAGS_DATASETS,
-    operation_id="get_datasets_metadata",
+    operation_id="list_datasets_metadata",
     summary="Get datasets metadata",
 )
-async def get_datasets_metadata(location_id: LocationID, user_id: UserID):
+async def list_datasets_metadata(location_id: LocationID, user_id: UserID):
     """returns all the top level datasets a user has access to"""
 
 

api/specs/web-server/_storage.py

@@ -61,7 +61,7 @@ async def synchronise_meta_data_table(
     response_model=Envelope[list[DatasetMetaData]],
     summary="Get datasets metadata",
 )
-async def get_datasets_metadata(location_id: LocationID):
+async def list_datasets_metadata(location_id: LocationID):
     """returns all the top level datasets a user has access to"""
 
 

services/storage/src/simcore_service_storage/api/v0/openapi.yaml

@@ -26,7 +26,7 @@ paths:
       - datasets
       summary: Get datasets metadata
       description: returns all the top level datasets a user has access to
-      operationId: get_datasets_metadata
+      operationId: list_datasets_metadata
       parameters:
       - name: location_id
         in: path

services/storage/src/simcore_service_storage/handlers_datasets.py

@@ -37,7 +37,7 @@ async def list_datasets_metadata(request: web.Request) -> web.Response:
     )
     path_params = parse_request_path_parameters_as(LocationPathParams, request)
     log.debug(
-        "received call to get_datasets_metadata with %s",
+        "received call to list_datasets_metadata with %s",
         f"{path_params=}, {query_params=}",
     )
 

services/storage/tests/unit/test_handlers_datasets.py

@@ -82,7 +82,7 @@ async def test_get_files_metadata_dataset(
         assert fmd.file_size == file.stat().st_size
 
 
-async def test_get_datasets_metadata(
+async def test_list_datasets_metadata(
     client: TestClient,
     user_id: UserID,
     location_id: int,
@@ -91,7 +91,7 @@ async def test_get_datasets_metadata(
     assert client.app
 
     url = (
-        client.app.router["get_datasets_metadata"]
+        client.app.router["list_datasets_metadata"]
         .url_for(location_id=f"{location_id}")
         .with_query(user_id=f"{user_id}")
     )

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -5719,7 +5719,7 @@ paths:
       - storage
       summary: Get datasets metadata
       description: returns all the top level datasets a user has access to
-      operationId: get_datasets_metadata
+      operationId: list_datasets_metadata
       parameters:
       - name: location_id
         in: path

services/web/server/src/simcore_service_webserver/storage/_handlers.py

@@ -1,7 +1,8 @@
-""" Handlers exposed by storage subsystem
+"""Handlers exposed by storage subsystem
 
-    Mostly resolves and redirect to storage API
+Mostly resolves and redirect to storage API
 """
+
 import logging
 from typing import Any, Final, NamedTuple
 
@@ -110,10 +111,10 @@ async def get_storage_locations(request: web.Request) -> web.Response:
     return create_data_response(payload, status=status)
 
 
-@routes.get(_path_prefix + "/{location_id}/datasets", name="get_datasets_metadata")
+@routes.get(_path_prefix + "/{location_id}/datasets", name="list_datasets_metadata")
 @login_required
 @permission_required("storage.files.*")
-async def get_datasets_metadata(request: web.Request) -> web.Response:
+async def list_datasets_metadata(request: web.Request) -> web.Response:
     class _PathParams(BaseModel):
         location_id: LocationID
 

services/web/server/tests/unit/with_dbs/01/test_storage.py

@@ -215,13 +215,13 @@ async def test_sync_file_meta_table(
         (UserRole.TESTER, status.HTTP_200_OK),
     ],
 )
-async def test_get_datasets_metadata(
+async def test_list_datasets_metadata(
     client: TestClient, storage_server: TestServer, logged_user, expected
 ):
     url = "/v0/storage/locations/0/datasets"
     assert url.startswith(PREFIX)
 
-    _url = client.app.router["get_datasets_metadata"].url_for(location_id="0")
+    _url = client.app.router["list_datasets_metadata"].url_for(location_id="0")
 
     assert url == str(_url)