refactor: simplify query parameter handling in get_solvers_filters and update descriptions in SolversListFilters

Author: pcrespov

services/api-server/src/simcore_service_api_server/api/dependencies/models_schemas_solvers_filters.py

@@ -1,24 +1,32 @@
-from typing import Annotated
+from typing import Annotated, Any
 
 from fastapi import Query
+from pydantic.fields import FieldInfo
 
 from ...models.schemas.solvers_filters import SolversListFilters
 
 
+def _get_query_params(field: FieldInfo) -> dict[str, Any]:
+    params = {}
+
+    if field.description:
+        params["description"] = field.description
+    if field.examples:
+        params["example"] = next(
+            (example for example in field.examples if "*" in example), field.examples[0]
+        )
+    return params
+
+
 def get_solvers_filters(
+    # pylint: disable=unsubscriptable-object
     solver_id: Annotated[
         str | None,
-        Query(
-            description="Filter by solver ID pattern",
-            example="simcore/services/comp/*",
-        ),
+        Query(**_get_query_params(SolversListFilters.model_fields["solver_id"])),
     ] = None,
     version_display: Annotated[
         str | None,
-        Query(
-            description="Filter by version display pattern",
-            example=["*2023-*"],
-        ),
+        Query(**_get_query_params(SolversListFilters.model_fields["version_display"])),
     ] = None,
 ) -> SolversListFilters:
     return SolversListFilters(

services/api-server/src/simcore_service_api_server/models/schemas/solvers_filters.py

@@ -9,15 +9,15 @@ class SolversListFilters(BaseModel):
     solver_id: Annotated[
         str | None,
         Field(
-            description="Filter by solver ID pattern (e.g. 'simcore/services/comp/itis/*')",
+            description="Filter by solver ID pattern",
             examples=["simcore/services/comp/itis/sleeper", "simcore/services/comp/*"],
         ),
     ] = None
 
     version_display: Annotated[
         str | None,
         Field(
-            description="Filter by version display pattern (e.g. '*2023*')",
+            description="Filter by version display pattern",
             examples=["2.1.1-2023-10-01", "*2023*"],
         ),
     ] = None