initial page model

Author: sanderegg

api/specs/web-server/_storage.py

@@ -4,9 +4,10 @@
 # pylint: disable=too-many-arguments
 
 
-from typing import TypeAlias
+from typing import Annotated, TypeAlias
 
-from fastapi import APIRouter, Query, status
+from _common import as_query
+from fastapi import APIRouter, Depends, Query, status
 from models_library.api_schemas_storage import (
     FileMetaDataGet,
     FileUploadCompleteFutureResponse,
@@ -16,8 +17,13 @@
     LinkType,
     PresignedLink,
 )
+from models_library.api_schemas_webserver.storage import (
+    ListPathsQueryParams,
+    StorageLocationPathParams,
+)
 from models_library.generics import Envelope
 from models_library.projects_nodes_io import LocationID
+from models_library.rest_pagination import Page
 from pydantic import AnyUrl, ByteSize
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.storage.schemas import DatasetMetaData, FileMetaData
@@ -44,12 +50,25 @@ async def list_storage_locations():
     """Returns the list of available storage locations"""
 
 
+@router.get(
+    "/storage/locations/{location_id}/paths",
+    response_model=Page[FileMetaDataGet],
+)
+async def list_paths(
+    _path: Annotated[StorageLocationPathParams, Depends()],
+    _query: Annotated[as_query(ListPathsQueryParams), Depends()],
+):
+    """Lists the files/directories in WorkingDirectory"""
+
+
 @router.get(
     "/storage/locations/{location_id}/datasets",
     response_model=Envelope[list[DatasetMetaData]],
     summary="Get datasets metadata",
 )
-async def list_datasets_metadata(location_id: LocationID):
+async def list_datasets_metadata(
+    _path: Annotated[StorageLocationPathParams, Depends()],
+):
     """returns all the top level datasets a user has access to"""
 
 
@@ -59,7 +78,7 @@ async def list_datasets_metadata(location_id: LocationID):
     summary="Get datasets metadata",
 )
 async def get_files_metadata(
-    location_id: LocationID,
+    _path: Annotated[StorageLocationPathParams, Depends()],
     uuid_filter: str = "",
     expand_dirs: bool = Query(
         True,

packages/models-library/src/models_library/api_schemas_webserver/storage.py

@@ -0,0 +1,15 @@
+from pathlib import Path
+
+from pydantic import BaseModel
+
+from ..projects_nodes_io import LocationID
+from ..rest_pagination import PageQueryParameters
+from ._base import InputSchema
+
+
+class StorageLocationPathParams(BaseModel):
+    location_id: LocationID
+
+
+class ListPathsQueryParams(InputSchema, PageQueryParameters):
+    file_filter: Path | None = None

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

@@ -5651,6 +5651,50 @@ paths:
                   $ref: '#/components/schemas/DatasetMetaData'
                 type: array
                 title: Response List Storage Locations
+  /v0/storage/locations/{location_id}/paths:
+    get:
+      tags:
+      - storage
+      summary: List Paths
+      description: Lists the files/directories in WorkingDirectory
+      operationId: list_paths
+      parameters:
+      - name: location_id
+        in: path
+        required: true
+        schema:
+          type: integer
+          title: Location Id
+      - name: limit
+        in: query
+        required: false
+        schema:
+          type: integer
+          default: 20
+          title: Limit
+      - name: offset
+        in: query
+        required: false
+        schema:
+          type: integer
+          default: 0
+          title: Offset
+      - name: fileFilter
+        in: query
+        required: false
+        schema:
+          anyOf:
+          - type: string
+            format: path
+          - type: 'null'
+          title: Filefilter
+      responses:
+        '200':
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Page_FileMetaDataGet_'
   /v0/storage/locations/{location_id}/datasets:
     get:
       tags:
@@ -11379,6 +11423,24 @@ components:
       - _links
       - data
       title: Page[CatalogServiceGet]
+    Page_FileMetaDataGet_:
+      properties:
+        _meta:
+          $ref: '#/components/schemas/PageMetaInfoLimitOffset'
+        _links:
+          $ref: '#/components/schemas/PageLinks'
+        data:
+          items:
+            $ref: '#/components/schemas/FileMetaDataGet'
+          type: array
+          title: Data
+      additionalProperties: false
+      type: object
+      required:
+      - _meta
+      - _links
+      - data
+      title: Page[FileMetaDataGet]
     Page_LicensedItemPurchaseGet_:
       properties:
         _meta: