workspaces query

Author: pcrespov

api/specs/web-server/_workspaces.py

@@ -23,10 +23,18 @@
     WorkspacesFilters,
     WorkspacesGroupsBodyParams,
     WorkspacesGroupsPathParams,
-    WorkspacesListWithJsonStrQueryParams,
+    WorkspacesOrderByJsonQueryParams,
     WorkspacesPathParams,
 )
 
+
+class _ListQueryParams(WorkspacesOrderByJsonQueryParams):
+    filters: Annotated[
+        Json | None,
+        Query(description=WorkspacesFilters.schema_json(indent=1)),
+    ] = None
+
+
 router = APIRouter(
     prefix=f"/{API_VTAG}",
     tags=[
@@ -51,21 +59,7 @@ async def create_workspace(
     response_model=Envelope[list[WorkspaceGet]],
 )
 async def list_workspaces(
-    order_by: Annotated[
-        Json,
-        Query(
-            description=WorkspacesListWithJsonStrQueryParams.__fields__[
-                "order_by"
-            ].field_info.description,
-            example=WorkspacesListWithJsonStrQueryParams.__fields__[
-                "order_by"
-            ].field_info.extra.get("example"),
-        ),
-    ] = WorkspacesListWithJsonStrQueryParams.__fields__["order_by"].field_info.default,
-    filters: Annotated[
-        Json | None,
-        Query(description=WorkspacesFilters.schema_json(indent=1)),
-    ] = None,
+    _q: Annotated[_ListQueryParams, Depends()],
 ):
     ...
 

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

@@ -2,12 +2,16 @@
 
 from models_library.basic_types import IDStr
 from models_library.rest_filters import Filters, FiltersQueryParameters
-from models_library.rest_ordering import OrderBy, OrderDirection
+from models_library.rest_ordering import (
+    OrderBy,
+    OrderDirection,
+    create_order_by_query_model_classes,
+)
 from models_library.rest_pagination import PageQueryParameters
 from models_library.trash import RemoveQueryParams
 from models_library.users import GroupID, UserID
 from models_library.workspaces import WorkspaceID
-from pydantic import BaseModel, Extra, Field, Json, validator
+from pydantic import BaseModel, Extra, Field
 from servicelib.aiohttp.requests_validation import RequestParams, StrictRequestParams
 from servicelib.request_keys import RQT_USERID_KEY
 
@@ -32,31 +36,23 @@ class WorkspacesFilters(Filters):
     )
 
 
-class WorkspacesListWithJsonStrQueryParams(
-    PageQueryParameters, FiltersQueryParameters[WorkspacesFilters]
-):
-    # pylint: disable=unsubscriptable-object
-    order_by: Json[OrderBy] = Field(
-        default=OrderBy(field=IDStr("modified"), direction=OrderDirection.DESC),
-        description="Order by field (modified_at|name|description) and direction (asc|desc). The default sorting order is ascending.",
-        example='{"field": "name", "direction": "desc"}',
-        alias="order_by",
-    )
+(
+    WorkspacesOrderByQueryParams,
+    WorkspacesOrderByJsonQueryParams,
+) = create_order_by_query_model_classes(
+    sortable_fields={"modified", "name"},
+    default_order_by=OrderBy(
+        field=IDStr("modified"),
+        direction=OrderDirection.DESC,
+    ),
+)
 
-    @validator("order_by", check_fields=False)
-    @classmethod
-    def _validate_order_by_field(cls, v):
-        if v.field not in {
-            "modified_at",
-            "name",
-            "description",
-        }:
-            msg = f"We do not support ordering by provided field {v.field}"
-            raise ValueError(msg)
-        if v.field == "modified_at":
-            v.field = "modified"
-        return v
 
+class WorkspacesListQueryParams(
+    PageQueryParameters,
+    FiltersQueryParameters[WorkspacesFilters],
+    WorkspacesOrderByQueryParams,
+):
     class Config:
         extra = Extra.forbid
 

services/web/server/src/simcore_service_webserver/workspaces/_workspaces_handlers.py

@@ -28,7 +28,7 @@
 from ._exceptions_handlers import handle_plugin_requests_exceptions
 from ._models import (
     WorkspacesFilters,
-    WorkspacesListWithJsonStrQueryParams,
+    WorkspacesListQueryParams,
     WorkspacesPathParams,
     WorkspacesRequestContext,
 )
@@ -65,13 +65,14 @@ async def create_workspace(request: web.Request):
 @handle_plugin_requests_exceptions
 async def list_workspaces(request: web.Request):
     req_ctx = WorkspacesRequestContext.parse_obj(request)
-    query_params: WorkspacesListWithJsonStrQueryParams = (
-        parse_request_query_parameters_as(WorkspacesListWithJsonStrQueryParams, request)
+    query_params: WorkspacesListQueryParams = parse_request_query_parameters_as(
+        WorkspacesListQueryParams, request
     )
 
     if not query_params.filters:
         query_params.filters = WorkspacesFilters()
 
+    assert query_params.filters
     workspaces: WorkspaceGetPage = await _workspaces_api.list_workspaces(
         app=request.app,
         user_id=req_ctx.user_id,