models

Author: pcrespov

api/specs/web-server/_folders.py

@@ -18,6 +18,7 @@
 from models_library.folders import FolderID
 from models_library.generics import Envelope
 from models_library.rest_pagination import PageQueryParameters
+from models_library.utils.json_serialization import json_dumps
 from models_library.workspaces import WorkspaceID
 from pydantic import Json
 from simcore_service_webserver._meta import API_VTAG
@@ -27,6 +28,27 @@
     FoldersPathParams,
 )
 
+
+class _ListQuery(PageQueryParameters):
+    workspace_id: WorkspaceID | None = None
+    folder_id: FolderID | None = None
+
+    order_by: Annotated[
+        Json,
+        Query(
+            description=FolderListWithJsonStrQueryParams.__fields__[
+                "order_by"
+            ].field_info.description,
+        ),
+    ] = json_dumps(
+        FolderListWithJsonStrQueryParams.__fields__["order_by"].field_info.default
+    )
+    filters: Annotated[
+        Json | None,
+        Query(description=FolderFilters.schema_json(indent=1)),
+    ] = None
+
+
 router = APIRouter(
     prefix=f"/{API_VTAG}",
     tags=[
@@ -49,24 +71,7 @@ async def create_folder(_b: CreateFolderBodyParams):
     response_model=Envelope[list[FolderGet]],
 )
 async def list_folders(
-    _q: Annotated[PageQueryParameters, Depends()],
-    folder_id: FolderID | None = None,
-    workspace_id: WorkspaceID | None = None,
-    order_by: Annotated[
-        Json,
-        Query(
-            description=FolderListWithJsonStrQueryParams.__fields__[
-                "order_by"
-            ].field_info.description,
-            example=FolderListWithJsonStrQueryParams.__fields__[
-                "order_by"
-            ].field_info.extra.get("example"),
-        ),
-    ] = FolderListWithJsonStrQueryParams.__fields__["order_by"].field_info.default,
-    filters: Annotated[
-        Json | None,
-        Query(description=FolderFilters.schema_json(indent=1)),
-    ] = None,
+    _q: Annotated[_ListQuery, Depends()],
 ):
     ...
 

services/web/server/src/simcore_service_webserver/folders/_models.py

@@ -12,7 +12,7 @@
     null_or_none_str_to_none_validator,
 )
 from models_library.workspaces import WorkspaceID
-from pydantic import Extra, Field, Json, validator
+from pydantic import BaseModel, Extra, Field, Json, validator
 from servicelib.aiohttp.requests_validation import RequestParams, StrictRequestParams
 from servicelib.request_keys import RQT_USERID_KEY
 
@@ -89,7 +89,6 @@ class Config:
     )(null_or_none_str_to_none_validator)
 
 
-
 class FolderListFullSearchWithJsonStrQueryParams(
     PageQueryParameters, FolderListSortParams, FiltersQueryParameters[FolderFilters]
 ):
@@ -108,7 +107,6 @@ class Config:
         extra = Extra.forbid
 
 
-
 assert RemoveQueryParams  # nosec
 
 __all__: tuple[str, ...] = ("RemoveQueryParams",)