refactor

Author: sanderegg

api/specs/storage/openapi.py

@@ -105,10 +105,10 @@ async def list_datasets_metadata(location_id: LocationID, user_id: UserID):
     f"/{API_VTAG}/locations/{{location_id}}/datasets/{{dataset_id}}/metadata",
     response_model=Envelope[list[FileMetaDataGet]],
     tags=TAGS_DATASETS,
-    operation_id="get_files_metadata_dataset",
+    operation_id="list_dataset_files_metadata",
     summary="Get Files Metadata",
 )
-async def get_files_metadata_dataset(
+async def list_dataset_files_metadata(
     location_id: LocationID,
     dataset_id: str,
     user_id: UserID,

api/specs/web-server/_storage.py

@@ -88,7 +88,7 @@ async def get_files_metadata(
     response_model=Envelope[list[FileMetaDataGet]],
     summary="Get Files Metadata",
 )
-async def get_files_metadata_dataset(
+async def list_dataset_files_metadata(
     location_id: LocationID,
     dataset_id: str,
     expand_dirs: bool = Query(

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

@@ -55,7 +55,7 @@ paths:
       - datasets
       summary: Get Files Metadata
       description: returns all the file meta data inside dataset with dataset_id
-      operationId: get_files_metadata_dataset
+      operationId: list_dataset_files_metadata
       parameters:
       - name: location_id
         in: path

services/storage/src/simcore_service_storage/handlers_datasets.py

@@ -49,17 +49,17 @@ async def list_datasets_metadata(request: web.Request) -> web.Response:
 
 @routes.get(
     f"/{API_VTAG}/locations/{{location_id}}/datasets/{{dataset_id}}/metadata",
-    name="get_files_metadata_dataset",
+    name="list_dataset_files_metadata",
 )
-async def get_files_metadata_dataset(request: web.Request) -> web.Response:
+async def list_dataset_files_metadata(request: web.Request) -> web.Response:
     query_params: FilesMetadataDatasetQueryParams = parse_request_query_parameters_as(
         FilesMetadataDatasetQueryParams, request
     )
     path_params = parse_request_path_parameters_as(
         FilesMetadataDatasetPathParams, request
     )
     log.debug(
-        "received call to get_files_metadata_dataset with %s",
+        "received call to list_dataset_files_metadata with %s",
         f"{path_params=}, {query_params=}",
     )
     dsm = get_dsm_provider(request.app).get(path_params.location_id)

services/storage/tests/unit/test_handlers_datasets.py

@@ -28,15 +28,15 @@
 pytest_simcore_ops_services_selection = ["adminer"]
 
 
-async def test_get_files_metadata_dataset_with_no_files_returns_empty_array(
+async def test_list_dataset_files_metadata_with_no_files_returns_empty_array(
     client: TestClient,
     user_id: UserID,
     project_id: ProjectID,
     location_id: int,
 ):
     assert client.app
     url = (
-        client.app.router["get_files_metadata_dataset"]
+        client.app.router["list_dataset_files_metadata"]
         .url_for(location_id=f"{location_id}", dataset_id=f"{project_id}")
         .with_query(user_id=user_id)
     )
@@ -51,7 +51,7 @@ async def test_get_files_metadata_dataset_with_no_files_returns_empty_array(
     [parametrized_file_size("100Mib")],
     ids=byte_size_ids,
 )
-async def test_get_files_metadata_dataset(
+async def test_list_dataset_files_metadata(
     upload_file: Callable[[ByteSize, str], Awaitable[tuple[Path, SimcoreS3FileID]]],
     client: TestClient,
     user_id: UserID,
@@ -65,7 +65,7 @@ async def test_get_files_metadata_dataset(
     for n in range(NUM_FILES):
         file, file_id = await upload_file(file_size, faker.file_name())
         url = (
-            client.app.router["get_files_metadata_dataset"]
+            client.app.router["list_dataset_files_metadata"]
             .url_for(location_id=f"{location_id}", dataset_id=f"{project_id}")
             .with_query(user_id=user_id)
         )
@@ -120,7 +120,7 @@ async def test_ensure_expand_dirs_defaults_true(
 
     assert client.app
     url = (
-        client.app.router["get_files_metadata_dataset"]
+        client.app.router["list_dataset_files_metadata"]
         .url_for(location_id=f"{location_id}", dataset_id=f"{project_id}")
         .with_query(user_id=user_id)
     )

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

@@ -5780,7 +5780,7 @@ paths:
       - storage
       summary: Get Files Metadata
       description: returns all the file meta data inside dataset with dataset_id
-      operationId: get_files_metadata_dataset
+      operationId: list_dataset_files_metadata
       parameters:
       - name: location_id
         in: path

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

@@ -151,11 +151,11 @@ class _QueryParams(BaseModel):
 
 @routes.get(
     _path_prefix + "/{location_id}/datasets/{dataset_id}/metadata",
-    name="get_files_metadata_dataset",
+    name="list_dataset_files_metadata",
 )
 @login_required
 @permission_required("storage.files.*")
-async def get_files_metadata_dataset(request: web.Request) -> web.Response:
+async def list_dataset_files_metadata(request: web.Request) -> web.Response:
     class _PathParams(BaseModel):
         location_id: LocationID
         dataset_id: str

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

@@ -242,13 +242,13 @@ async def test_list_datasets_metadata(
         (UserRole.TESTER, status.HTTP_200_OK),
     ],
 )
-async def test_get_files_metadata_dataset(
+async def test_list_dataset_files_metadata(
     client: TestClient, storage_server: TestServer, logged_user, expected
 ):
     url = "/v0/storage/locations/0/datasets/N:asdfsdf/metadata"
     assert url.startswith(PREFIX)
 
-    _url = client.app.router["get_files_metadata_dataset"].url_for(
+    _url = client.app.router["list_dataset_files_metadata"].url_for(
         location_id="0", dataset_id="N:asdfsdf"
     )