api model

Author: sanderegg

packages/models-library/src/models_library/storage_schemas.py

@@ -372,8 +372,14 @@ class SoftCopyBody(BaseModel):
 
 
 class PathMetaDataGet(BaseModel):
-    path: Path
+    path: Annotated[Path, Field(description="the path to the current path")]
+    display_path: Annotated[
+        Path, Field(description="the path to display with UUID replaced")
+    ]
     created_at: datetime
     last_modified: datetime
 
-    file_meta_data: FileMetaDataGet | None
+    file_meta_data: Annotated[
+        FileMetaDataGet | None,
+        Field(description="if filled, this is the file meta data of the s3 object"),
+    ]

services/storage/src/simcore_service_storage/api/rest/_paths.py

@@ -36,4 +36,6 @@ async def list_paths(
         limit=page_params.limit,
         offset=page_params.offset,
     )
-    return create_page(items, total=total_number, params=page_params)
+    return create_page(
+        [_.to_api_model() for _ in items], total=total_number, params=page_params
+    )

services/storage/src/simcore_service_storage/models.py

@@ -27,6 +27,7 @@
     ETag,
     FileMetaDataGet,
     LinkType,
+    PathMetaDataGet,
     S3BucketName,
 )
 from models_library.users import UserID
@@ -44,6 +45,7 @@
     model_validator,
     validate_call,
 )
+from simcore_postgres_database.models import file_meta_data
 
 
 class DatasetMetaData(DatasetMetaDataGet):
@@ -329,3 +331,12 @@ class PathMetaData(BaseModel):
     file_meta_data: FileMetaData | None
 
     model_config = ConfigDict(from_attributes=True)
+
+    def to_api_model(self) -> PathMetaDataGet:
+        return PathMetaDataGet.model_construct(
+            path=self.path,
+            display_path=self.path,
+            created_at=self.created_at,
+            last_modified=self.last_modified,
+            file_meta_data=self.file_meta_data,
+        )