refactoring routes

Author: sanderegg

services/datcore-adapter/src/simcore_service_datcore_adapter/api/module_setup.py

@@ -6,10 +6,13 @@
 from fastapi_pagination import Page, Params
 from fastapi_pagination.api import create_page, resolve_params
 from fastapi_pagination.bases import RawParams
+from models_library.api_schemas_datcore_adapter.datasets import (
+    DatasetMetaData,
+    FileMetaData,
+)
 from servicelib.fastapi.requests_decorators import cancel_on_disconnect
 from starlette import status
 
-from ...models.domains.datasets import DatasetsOut, FileMetaDataOut
 from ...modules.pennsieve import PennsieveApiClient
 from ..dependencies.pennsieve import get_pennsieve_api_client
 
@@ -26,7 +29,7 @@
     "/datasets",
     summary="list datasets",
     status_code=status.HTTP_200_OK,
-    response_model=Page[DatasetsOut],
+    response_model=Page[DatasetMetaData],
 )
 @cancel_on_disconnect
 @cached(
@@ -39,7 +42,7 @@ async def list_datasets(
     x_datcore_api_secret: Annotated[str, Header(..., description="Datcore API Secret")],
     pennsieve_client: Annotated[PennsieveApiClient, Depends(get_pennsieve_api_client)],
     params: Annotated[Params, Depends()],
-) -> Page[DatasetsOut]:
+) -> Page[DatasetMetaData]:
     assert request  # nosec
     raw_params: RawParams = resolve_params(params).to_raw_params()
     assert raw_params.limit is not None  # nosec
@@ -57,7 +60,7 @@ async def list_datasets(
     "/datasets/{dataset_id}/files",
     summary="list top level files/folders in a dataset",
     status_code=status.HTTP_200_OK,
-    response_model=Page[FileMetaDataOut],
+    response_model=Page[FileMetaData],
 )
 @cancel_on_disconnect
 @cached(
@@ -71,7 +74,7 @@ async def list_dataset_top_level_files(
     x_datcore_api_secret: Annotated[str, Header(..., description="Datcore API Secret")],
     pennsieve_client: Annotated[PennsieveApiClient, Depends(get_pennsieve_api_client)],
     params: Annotated[Params, Depends()],
-) -> Page[FileMetaDataOut]:
+) -> Page[FileMetaData]:
     assert request  # nosec
     raw_params: RawParams = resolve_params(params).to_raw_params()
 
@@ -91,7 +94,7 @@ async def list_dataset_top_level_files(
     "/datasets/{dataset_id}/files/{collection_id}",
     summary="list top level files/folders in a collection in a dataset",
     status_code=status.HTTP_200_OK,
-    response_model=Page[FileMetaDataOut],
+    response_model=Page[FileMetaData],
 )
 @cancel_on_disconnect
 @cached(
@@ -106,7 +109,7 @@ async def list_dataset_collection_files(
     x_datcore_api_secret: Annotated[str, Header(..., description="Datcore API Secret")],
     pennsieve_client: Annotated[PennsieveApiClient, Depends(get_pennsieve_api_client)],
     params: Annotated[Params, Depends()],
-) -> Page[FileMetaDataOut]:
+) -> Page[FileMetaData]:
     assert request  # nosec
     raw_params: RawParams = resolve_params(params).to_raw_params()
     assert raw_params.limit is not None  # nosec
@@ -126,7 +129,7 @@ async def list_dataset_collection_files(
     "/datasets/{dataset_id}/files_legacy",
     summary="list all file meta data in dataset",
     status_code=status.HTTP_200_OK,
-    response_model=list[FileMetaDataOut],
+    response_model=list[FileMetaData],
 )
 @cancel_on_disconnect
 @cached(
@@ -139,7 +142,7 @@ async def list_dataset_files_legacy(
     x_datcore_api_key: Annotated[str, Header(..., description="Datcore API Key")],
     x_datcore_api_secret: Annotated[str, Header(..., description="Datcore API Secret")],
     pennsieve_client: Annotated[PennsieveApiClient, Depends(get_pennsieve_api_client)],
-) -> list[FileMetaDataOut]:
+) -> list[FileMetaData]:
     assert request  # nosec
     return await pennsieve_client.list_all_dataset_files(
         api_key=x_datcore_api_key,

services/datcore-adapter/src/simcore_service_datcore_adapter/api/rest/datasets.py

@@ -1,17 +1,18 @@
 import logging
-from typing import Annotated, Any
+from typing import Annotated
 
 from fastapi import APIRouter, Depends, Header, Request
+from models_library.api_schemas_datcore_adapter.datasets import PackageMetaData
 from pydantic import AnyUrl, TypeAdapter
 from servicelib.fastapi.requests_decorators import cancel_on_disconnect
 from starlette import status
 
-from ...models.domains.files import FileDownloadOut
+from ...models.files import FileDownloadOut
 from ...modules.pennsieve import PennsieveApiClient
 from ..dependencies.pennsieve import get_pennsieve_api_client
 
 router = APIRouter()
-log = logging.getLogger(__file__)
+_logger = logging.getLogger(__file__)
 
 
 @router.get(
@@ -62,7 +63,7 @@ async def delete_file(
     "/packages/{package_id}/files",
     summary="returns a package (i.e. a file)",
     status_code=status.HTTP_200_OK,
-    response_model=list[dict[str, Any]],
+    response_model=list[PackageMetaData],
 )
 @cancel_on_disconnect
 async def get_package(
@@ -71,12 +72,15 @@ async def get_package(
     x_datcore_api_key: Annotated[str, Header(..., description="Datcore API Key")],
     x_datcore_api_secret: Annotated[str, Header(..., description="Datcore API Secret")],
     pennsieve_client: Annotated[PennsieveApiClient, Depends(get_pennsieve_api_client)],
-) -> list[dict[str, Any]]:
+) -> list[PackageMetaData]:
     assert request  # nosec
-    return await pennsieve_client.get_package_files(
+
+    data = await pennsieve_client.get_package_files(
         api_key=x_datcore_api_key,
         api_secret=x_datcore_api_secret,
         package_id=package_id,
         limit=1,
         offset=0,
+        fill_path=True,
     )
+    return [_.to_api_model() for _ in data]

services/datcore-adapter/src/simcore_service_datcore_adapter/api/rest/files.py

@@ -5,7 +5,7 @@
 from servicelib.fastapi.requests_decorators import cancel_on_disconnect
 from starlette import status
 
-from ...models.domains.user import Profile
+from ...models.user import Profile
 from ...modules.pennsieve import PennsieveApiClient
 from ..dependencies.pennsieve import get_pennsieve_api_client
 

services/datcore-adapter/src/simcore_service_datcore_adapter/api/rest/user.py

@@ -0,0 +1,18 @@
+"""
+api app module
+"""
+
+from fastapi import APIRouter, FastAPI
+
+from .._meta import API_VTAG
+from .rest import datasets, files, health, user
+
+
+def setup_rest_api_routes(app: FastAPI) -> None:
+    router = APIRouter()
+
+    app.include_router(router, prefix=f"/{API_VTAG}")
+    app.include_router(health.router, tags=["healthcheck"], prefix=f"/{API_VTAG}")
+    app.include_router(user.router, tags=["user"], prefix=f"/{API_VTAG}")
+    app.include_router(datasets.router, tags=["datasets"], prefix=f"/{API_VTAG}")
+    app.include_router(files.router, tags=["files"], prefix=f"/{API_VTAG}")