add deprecation warnings to all listing endpoints

Author: bisgaard-itis

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

@@ -29,6 +29,11 @@
     get_upload_links_from_s3,
 )
 from simcore_sdk.node_ports_common.filemanager import upload_path as storage_upload_path
+from simcore_service_api_server.api.routes._constants import (
+    FMSG_CHANGELOG_ADDED_IN_VERSION,
+    FMSG_CHANGELOG_REMOVED_IN_VERSION_FORMAT,
+    create_route_description,
+)
 from starlette.datastructures import URL
 from starlette.responses import RedirectResponse
 
@@ -132,7 +137,20 @@ async def _create_domain_file(
     return file
 
 
-@router.get("", response_model=list[OutputFile], responses=_FILE_STATUS_CODES)
+@router.get(
+    "",
+    response_model=list[OutputFile],
+    responses=_FILE_STATUS_CODES,
+    description=create_route_description(
+        base="Lists all files stored in the system",
+        deprecated=True,
+        alternative="GET /v0/files/page",
+        changelog=[
+            FMSG_CHANGELOG_ADDED_IN_VERSION.format("0.5"),
+            FMSG_CHANGELOG_REMOVED_IN_VERSION_FORMAT.format("0.7"),
+        ],
+    ),
+)
 async def list_files(
     storage_client: Annotated[StorageApi, Depends(get_api_client(StorageApi))],
     user_id: Annotated[int, Depends(get_current_user_id)],

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

@@ -20,7 +20,11 @@
 from ..dependencies.services import get_api_client
 from ..dependencies.webserver_http import AuthSession, get_webserver_session
 from ._common import API_SERVER_DEV_FEATURES_ENABLED
-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,
+)
 
 _logger = logging.getLogger(__name__)
 
@@ -44,17 +48,27 @@
 #    Would be nice to have /solvers/foo/releases/latest or solvers/foo/releases/3 , similar to docker tagging
 
 
-@router.get("", response_model=list[Solver], responses=_SOLVER_STATUS_CODES)
+@router.get(
+    "",
+    response_model=list[Solver],
+    responses=_SOLVER_STATUS_CODES,
+    description=create_route_description(
+        base="Lists all available solvers (latest version)",
+        deprecated=True,
+        alternative="GET /v0/solvers/page",
+        changelog=[
+            FMSG_CHANGELOG_NEW_IN_VERSION.format("0.5.0"),
+            FMSG_CHANGELOG_REMOVED_IN_VERSION_FORMAT.format("0.7"),
+        ],
+    ),
+)
 async def list_solvers(
     user_id: Annotated[int, Depends(get_current_user_id)],
     catalog_client: Annotated[CatalogApi, Depends(get_api_client(CatalogApi))],
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
 ):
-    """Lists all available solvers (latest version)
-
-    SEE get_solvers_page for paginated version of this function
-    """
+    """Lists all available solvers (latest version)"""
     solvers: list[Solver] = await catalog_client.list_latest_releases(
         user_id=user_id, product_name=product_name
     )

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

@@ -144,11 +144,7 @@ async def list_jobs(
     url_for: Annotated[Callable, Depends(get_reverse_url_mapper)],
     product_name: Annotated[str, Depends(get_product_name)],
 ):
-    """List of jobs in a specific released solver (limited to 20 jobs)
-
-    - DEPRECATION: This implementation and returned values are deprecated and the will be replaced by that of get_jobs_page
-    - SEE `get_jobs_page` for paginated version of this function
-    """
+    """List of jobs in a specific released solver (limited to 20 jobs)"""
 
     solver = await solver_service.get_solver(
         user_id=user_id,