doc

Author: pcrespov

services/api-server/src/simcore_service_api_server/_service_solvers.py

@@ -125,15 +125,15 @@ async def solver_release_history(
         self,
         *,
         solver_key: SolverKeyId,
-        offset: NonNegativeInt,
-        limit: PositiveInt,
+        pagination_offset: NonNegativeInt,
+        pagination_limit: PositiveInt,
     ) -> tuple[list[Solver], PageMetaInfoLimitOffset]:
 
         releases, page_meta = (
             await self.catalog_service.list_release_history_latest_first(
                 filter_by_service_key=solver_key,
-                pagination_offset=offset,
-                pagination_limit=limit,
+                pagination_offset=pagination_offset,
+                pagination_limit=pagination_limit,
             )
         )
 
@@ -158,29 +158,29 @@ async def latest_solvers(
         *,
         pagination_offset: NonNegativeInt,
         pagination_limit: PositiveInt,
-        filter_by_solver_id: str | None = None,
-        filter_by_version_display: str | None = None,
+        filter_by_solver_key_pattern: str | None = None,
+        filter_by_version_display_pattern: str | None = None,
     ) -> tuple[list[Solver], PageMetaInfoLimitOffset]:
         """Lists the latest solvers with pagination and filtering.
 
         Args:
-            offset: Pagination offset
-            limit: Pagination limit
-            solver_id_pattern: Optional pattern to filter solvers by ID
-            version_display_pattern: Optional pattern to filter by version display
+            pagination_offset: Pagination offset
+            pagination_limit: Pagination limit
+            filter_by_solver_key_pattern: Optional pattern to filter solvers by key e.g. "simcore/service/my_solver*"
+            filter_by_version_display_pattern: Optional pattern to filter by version display e.g. "1.0.*-beta"
 
         Returns:
             A tuple with the list of filtered solvers and pagination metadata
         """
         filters = ServiceListFilters(service_type=ServiceType.COMPUTATIONAL)
 
         # Add key_pattern filter for solver ID if provided
-        if filter_by_solver_id:
-            filters.service_key_pattern = filter_by_solver_id
+        if filter_by_solver_key_pattern:
+            filters.service_key_pattern = filter_by_solver_key_pattern
 
         # Add version_display_pattern filter if provided
-        if filter_by_version_display:
-            filters.version_display_pattern = filter_by_version_display
+        if filter_by_version_display_pattern:
+            filters.version_display_pattern = filter_by_version_display_pattern
 
         services, page_meta = await self.catalog_service.list_latest_releases(
             pagination_offset=pagination_offset,

services/api-server/src/simcore_service_api_server/api/routes/solvers.py

@@ -45,7 +45,9 @@
     **DEFAULT_BACKEND_SERVICE_STATUS_CODES,
 }
 
-router = APIRouter()
+router = APIRouter(
+    # /v0/solvers/
+)
 
 
 @router.get(
@@ -98,8 +100,8 @@ async def list_solvers_paginated(
     solvers, page_meta = await solver_service.latest_solvers(
         pagination_offset=page_params.offset,
         pagination_limit=page_params.limit,
-        filter_by_solver_id=filters.solver_id,
-        filter_by_version_display=filters.version_display,
+        filter_by_solver_key_pattern=filters.solver_id,
+        filter_by_version_display_pattern=filters.version_display,
     )
 
     for solver in solvers:
@@ -145,8 +147,8 @@ async def list_solvers_releases(
         for page_params in iter_pagination_params(limit=DEFAULT_PAGINATION_LIMIT):
             solvers, page_meta = await solver_service.solver_release_history(
                 solver_key=solver.id,
-                offset=page_params.offset,
-                limit=page_params.limit,
+                pagination_offset=page_params.offset,
+                pagination_limit=page_params.limit,
             )
             page_params.total_number_of_items = page_meta.total
             all_solvers.extend(solvers)
@@ -216,8 +218,8 @@ async def list_solver_releases(
     for page_params in iter_pagination_params(limit=DEFAULT_PAGINATION_LIMIT):
         solvers, page_meta = await solver_service.solver_release_history(
             solver_key=solver_key,
-            offset=page_params.offset,
-            limit=page_params.limit,
+            pagination_offset=page_params.offset,
+            pagination_limit=page_params.limit,
         )
         page_params.total_number_of_items = page_meta.total
         all_releases.extend(solvers)
@@ -249,8 +251,8 @@ async def list_solver_releases_paginated(
 ):
     solvers, page_meta = await solver_service.solver_release_history(
         solver_key=solver_key,
-        offset=page_params.offset,
-        limit=page_params.limit,
+        pagination_offset=page_params.offset,
+        pagination_limit=page_params.limit,
     )
 
     for solver in solvers: