updates OAS

Author: pcrespov

api/specs/web-server/_folders.py

@@ -21,7 +21,7 @@
 from models_library.workspaces import WorkspaceID
 from pydantic import Json
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.folders._models import FoldersPathParams
+from simcore_service_webserver.folders._models import FolderFilters, FoldersPathParams
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -55,6 +55,10 @@ async def list_folders(
             example='{"field": "name", "direction": "desc"}',
         ),
     ] = '{"field": "modified_at", "direction": "desc"}',
+    filters: Annotated[
+        Json | None,
+        Query(description=FolderFilters.schema_json(indent=1)),
+    ] = None,
 ):
     ...
 

api/specs/web-server/_projects_crud.py

@@ -32,6 +32,7 @@
 from simcore_service_webserver.projects._common_models import ProjectPathParams
 from simcore_service_webserver.projects._crud_handlers import ProjectCreateParams
 from simcore_service_webserver.projects._crud_handlers_models import (
+    ProjectFilters,
     ProjectListFullSearchParams,
     ProjectListParams,
 )
@@ -83,7 +84,10 @@ async def list_projects(
             example='{"field": "last_change_date", "direction": "desc"}',
         ),
     ] = '{"field": "last_change_date", "direction": "desc"}',
-    filters: Annotated[Json | None, Query()] = None,
+    filters: Annotated[
+        Json | None,
+        Query(description=ProjectFilters.schema_json(indent=1)),
+    ] = None,
 ):
     ...
 

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

@@ -2609,6 +2609,27 @@ paths:
         example: '{"field": "name", "direction": "desc"}'
         name: order_by
         in: query
+      - description: "filters\n{\n \"title\": \"FolderFilters\",\n \"description\"\
+          : \"Encoded as JSON. Each available filter can have its own logic (should\
+          \ be well documented)\\nInspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList.\"\
+          ,\n \"type\": \"object\",\n \"properties\": {\n  \"trashed\": {\n   \"title\"\
+          : \"Trashed\",\n   \"description\": \"Set to true to list trashed, false\
+          \ to list non-trashed (default), None to list all\",\n   \"default\": false,\n\
+          \   \"type\": \"boolean\"\n  }\n }\n}"
+        required: false
+        schema:
+          title: Filters
+          type: string
+          description: "filters\n{\n \"title\": \"FolderFilters\",\n \"description\"\
+            : \"Encoded as JSON. Each available filter can have its own logic (should\
+            \ be well documented)\\nInspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList.\"\
+            ,\n \"type\": \"object\",\n \"properties\": {\n  \"trashed\": {\n   \"\
+            title\": \"Trashed\",\n   \"description\": \"Set to true to list trashed,\
+            \ false to list non-trashed (default), None to list all\",\n   \"default\"\
+            : false,\n   \"type\": \"boolean\"\n  }\n }\n}"
+          format: json-string
+        name: filters
+        in: query
       - required: false
         schema:
           title: Limit
@@ -3039,10 +3060,24 @@ paths:
         example: '{"field": "last_change_date", "direction": "desc"}'
         name: order_by
         in: query
-      - required: false
+      - description: "filters\n{\n \"title\": \"ProjectFilters\",\n \"description\"\
+          : \"Encoded as JSON. Each available filter can have its own logic (should\
+          \ be well documented)\\nInspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList.\"\
+          ,\n \"type\": \"object\",\n \"properties\": {\n  \"trashed\": {\n   \"title\"\
+          : \"Trashed\",\n   \"description\": \"Set to true to list trashed, false\
+          \ to list non-trashed (default), None to list all\",\n   \"default\": false,\n\
+          \   \"type\": \"boolean\"\n  }\n }\n}"
+        required: false
         schema:
           title: Filters
           type: string
+          description: "filters\n{\n \"title\": \"ProjectFilters\",\n \"description\"\
+            : \"Encoded as JSON. Each available filter can have its own logic (should\
+            \ be well documented)\\nInspired by Docker API https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerList.\"\
+            ,\n \"type\": \"object\",\n \"properties\": {\n  \"trashed\": {\n   \"\
+            title\": \"Trashed\",\n   \"description\": \"Set to true to list trashed,\
+            \ false to list non-trashed (default), None to list all\",\n   \"default\"\
+            : false,\n   \"type\": \"boolean\"\n  }\n }\n}"
           format: json-string
         name: filters
         in: query