add Deprecated note @pcrespov

Author: bisgaard-itis

services/api-server/openapi.json

@@ -2356,7 +2356,7 @@
           "solvers"
         ],
         "summary": "List Jobs",
-        "description": "List of jobs in a specific released solver (limited to 20 jobs)\n\n- DEPRECATION: This implementation and returned values are deprecated and the will be replaced by that of get_jobs_page\n- SEE `get_jobs_page` for paginated version of this function",
+        "description": "\ud83d\udea8 **Deprecated**: This endpoint is deprecated and will be removed in a future release.\nPlease use `GET /{solver_key}/releases/{version}/jobs/page` instead.\n\n\n\nList of jobs in a specific released solver\n\nNew in *version 0.5*\n\nRemoved in *version 0.7*: This endpoint is deprecated and will be removed in a future version",
         "operationId": "list_jobs",
         "security": [
           {

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

@@ -11,9 +11,7 @@
 class ProgramService:
     _catalog_service: CatalogService
 
-    def __init__(
-        self, _catalog_service: Annotated[CatalogService, Depends(CatalogService)]
-    ):
+    def __init__(self, _catalog_service: Annotated[CatalogService, Depends()]):
         self._catalog_service = _catalog_service
 
     async def get_program(

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

@@ -19,9 +19,7 @@
 class SolverService:
     _catalog_service: CatalogService
 
-    def __init__(
-        self, catalog_service: Annotated[CatalogService, Depends(CatalogService)]
-    ):
+    def __init__(self, catalog_service: Annotated[CatalogService, Depends()]):
         self._catalog_service = catalog_service
 
     async def get_solver(

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

@@ -20,3 +20,41 @@
 
 # removed on inputs/outputs in routes
 FMSG_CHANGELOG_REMOVED_IN_VERSION_FORMAT: Final[str] = "Removed in *version {}*: {}\n"
+
+FMSG_DEPRECATED_ROUTE_NOTICE: Final[str] = (
+    "🚨 **Deprecated**: This endpoint is deprecated and will be removed in a future release.\n"
+    "Please use `{}` instead.\n\n"
+)
+
+
+def create_route_description(
+    *,
+    base: str = "",
+    deprecated: bool = False,
+    alternative: str | None = None,  # alternative
+    changelog: list[str] | None = None
+) -> str:
+    """
+    Builds a consistent route description with optional deprecation and changelog information.
+
+    Args:
+        base (str): Main route description.
+        deprecated (tuple): (retirement_date, alternative_route) if deprecated.
+        changelog (List[str]): List of formatted changelog strings.
+
+    Returns:
+        str: Final description string.
+    """
+    parts = []
+
+    if deprecated:
+        assert alternative, "If deprecated, alternative must be provided"  # nosec
+        parts.append(FMSG_DEPRECATED_ROUTE_NOTICE.format(alternative))
+
+    if base:
+        parts.append(base)
+
+    if changelog:
+        parts.append("\n".join(changelog))
+
+    return "\n\n".join(parts)

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

@@ -68,7 +68,7 @@ async def get_program_release(
     program_key: ProgramKeyId,
     version: VersionStr,
     user_id: Annotated[int, Depends(get_current_user_id)],
-    program_service: Annotated[ProgramService, Depends(ProgramService)],
+    program_service: Annotated[ProgramService, Depends()],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
 ) -> Program:
@@ -107,8 +107,8 @@ async def create_program_job(
     program_key: ProgramKeyId,
     version: VersionStr,
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
-    program_service: Annotated[ProgramService, Depends(ProgramService)],
-    job_service: Annotated[JobService, Depends(JobService)],
+    program_service: Annotated[ProgramService, Depends()],
+    job_service: Annotated[JobService, Depends()],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
     x_simcore_parent_project_uuid: Annotated[ProjectID | None, Header()] = None,

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

@@ -95,8 +95,8 @@ async def create_solver_job(
     version: VersionStr,
     inputs: JobInputs,
     user_id: Annotated[PositiveInt, Depends(get_current_user_id)],
-    solver_service: Annotated[SolverService, Depends(SolverService)],
-    job_service: Annotated[JobService, Depends(JobService)],
+    solver_service: Annotated[SolverService, Depends()],
+    job_service: Annotated[JobService, Depends()],
     wb_api_rpc: Annotated[WbApiRpcClient, Depends(get_wb_api_rpc_client)],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],

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

@@ -55,7 +55,11 @@
 from ..dependencies.rabbitmq import get_log_check_timeout, get_log_distributor
 from ..dependencies.services import get_api_client
 from ..dependencies.webserver_http import AuthSession, get_webserver_session
-from ._constants import FMSG_CHANGELOG_NEW_IN_VERSION
+from ._constants import (
+    FMSG_CHANGELOG_NEW_IN_VERSION,
+    FMSG_CHANGELOG_REMOVED_IN_VERSION_FORMAT,
+    create_route_description,
+)
 from .solvers_jobs import (
     JOBS_STATUS_CODES,
     METADATA_STATUS_CODES,
@@ -118,6 +122,18 @@
     "/{solver_key:path}/releases/{version}/jobs",
     response_model=list[Job],
     responses=JOBS_STATUS_CODES,
+    description=create_route_description(
+        base="List of jobs in a specific released solver",
+        deprecated=True,
+        alternative="GET /{solver_key}/releases/{version}/jobs/page",
+        changelog=[
+            FMSG_CHANGELOG_NEW_IN_VERSION.format("0.5"),
+            FMSG_CHANGELOG_REMOVED_IN_VERSION_FORMAT.format(
+                "0.7",
+                "This endpoint is deprecated and will be removed in a future version",
+            ),
+        ],
+    ),
 )
 async def list_jobs(
     solver_key: SolverKeyId,