exposes api used by @mguidon

pcrespov · pcrespov · commit 297f79f1f320 · 2024-10-03T19:19:18.000+02:00
diff --git a/services/api-server/src/simcore_service_api_server/api/routes/files.py b/services/api-server/src/simcore_service_api_server/api/routes/files.py
@@ -2,15 +2,13 @@
 import datetime
 import io
 import logging
-from textwrap import dedent
 from typing import IO, Annotated, Any
 from uuid import UUID
 
 from fastapi import APIRouter, Body, Depends
 from fastapi import File as FileParam
 from fastapi import Header, Request, UploadFile, status
 from fastapi.exceptions import HTTPException
-from fastapi.responses import HTMLResponse
 from fastapi_pagination.api import create_page
 from models_library.api_schemas_storage import ETag, FileUploadCompletionBody, LinkType
 from models_library.basic_types import SHA256Str
@@ -29,7 +27,6 @@
 from starlette.datastructures import URL
 from starlette.responses import RedirectResponse
 
-from ..._meta import API_VTAG
 from ...exceptions.service_errors_utils import DEFAULT_BACKEND_SERVICE_STATUS_CODES
 from ...models.pagination import Page, PaginationParams
 from ...models.schemas.errors import ErrorGet
@@ -158,7 +155,11 @@ def _get_spooled_file_size(file_io: IO) -> int:
     return file_size
 
 
-@router.put("/content", response_model=File, responses=_FILE_STATUS_CODES)
+@router.put(
+    "/content",
+    response_model=File,
+    responses=_FILE_STATUS_CODES,
+)
 @cancel_on_disconnect
 async def upload_file(
     request: Request,
@@ -433,24 +434,3 @@ async def download_file(
 
     _logger.info("Downloading %s to %s ...", file_meta, presigned_download_link)
     return RedirectResponse(presigned_download_link)
-
-
-async def files_upload_multiple_view():
-    """Extra **Web form** to upload multiple files at http://localhost:8000/v0/files/upload-form-view
-        and overcomes the limitations of Swagger-UI view
-
-    NOTE: Only enabled if DEBUG=1
-    NOTE: As of 2020-10-07, Swagger UI doesn't support multiple file uploads in the same form field
-    """
-    return HTMLResponse(
-        content=dedent(
-            f"""
-        <body>
-        <form action="/{API_VTAG}/files:upload" enctype="multipart/form-data" method="post">
-        <input name="files" type="file" multiple>
-        <input type="submit">
-        </form>
-        </body>
-        """
-        )
-    )
diff --git a/services/api-server/src/simcore_service_api_server/api/routes/solvers.py b/services/api-server/src/simcore_service_api_server/api/routes/solvers.py
@@ -265,7 +265,8 @@ async def list_solver_ports(
 @router.get(
     "/{solver_key:path}/releases/{version}/pricing_plan",
     response_model=ServicePricingPlanGet,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
+    description="Gets solver pricing plan\n\n"
+    + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.7"),
     responses=_SOLVER_STATUS_CODES,
 )
 async def get_solver_pricing_plan(
diff --git a/services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs.py b/services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs.py
@@ -40,7 +40,6 @@
 from ..dependencies.authentication import get_current_user_id, get_product_name
 from ..dependencies.services import get_api_client
 from ..dependencies.webserver import AuthSession, get_webserver_session
-from ._common import API_SERVER_DEV_FEATURES_ENABLED
 from ._constants import FMSG_CHANGELOG_ADDED_IN_VERSION, FMSG_CHANGELOG_NEW_IN_VERSION
 
 _logger = logging.getLogger(__name__)
@@ -145,9 +144,8 @@ async def create_job(
     "/{solver_key:path}/releases/{version}/jobs/{job_id:uuid}",
     status_code=status.HTTP_204_NO_CONTENT,
     responses=JOBS_STATUS_CODES,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
     description="Deletes an existing solver job\n\n"
-    + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.5"),
+    + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.7"),
 )
 async def delete_job(
     solver_key: SolverKeyId,
@@ -271,9 +269,8 @@ async def inspect_job(
     "/{solver_key:path}/releases/{version}/jobs/{job_id:uuid}/metadata",
     response_model=JobMetadata,
     responses=METADATA_STATUS_CODES,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
     description="Updates custom metadata from a job\n\n"
-    + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.5"),
+    + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.7"),
 )
 async def replace_job_custom_metadata(
     solver_key: SolverKeyId,
diff --git a/services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs_getters.py b/services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs_getters.py
@@ -116,6 +116,7 @@
     "/{solver_key:path}/releases/{version}/jobs",
     response_model=list[Job],
     responses=JOBS_STATUS_CODES,
+    deprecated=True,
 )
 async def list_jobs(
     solver_key: SolverKeyId,
@@ -129,6 +130,8 @@ async def list_jobs(
     """List of jobs in a specific released solver (limited to 20 jobs)
 
     SEE `get_jobs_page` for paginated version of this function
+    NOTE: This implementation and returned values are deprecated and the
+          will be replaced by that of get_jobs_page
     """
 
     solver = await catalog_client.get_service(
@@ -158,7 +161,6 @@ async def list_jobs(
     "/{solver_key:path}/releases/{version}/jobs/page",
     response_model=Page[Job],
     responses=JOBS_STATUS_CODES,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
     description=(
         "List of jobs on a specific released solver (includes pagination)\n\n"
         + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.7")
@@ -349,9 +351,8 @@ async def get_job_output_logfile(
     "/{solver_key:path}/releases/{version}/jobs/{job_id:uuid}/metadata",
     response_model=JobMetadata,
     responses=METADATA_STATUS_CODES,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
     description="Gets custom metadata from a job\n\n"
-    + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.5"),
+    + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.7"),
 )
 async def get_job_custom_metadata(
     solver_key: SolverKeyId,
diff --git a/services/api-server/src/simcore_service_api_server/api/routes/wallets.py b/services/api-server/src/simcore_service_api_server/api/routes/wallets.py
@@ -7,7 +7,7 @@
 from ...exceptions.service_errors_utils import DEFAULT_BACKEND_SERVICE_STATUS_CODES
 from ...models.schemas.errors import ErrorGet
 from ..dependencies.webserver import AuthSession, get_webserver_session
-from ._common import API_SERVER_DEV_FEATURES_ENABLED
+from ._constants import FMSG_CHANGELOG_NEW_IN_VERSION
 
 _logger = logging.getLogger(__name__)
 
@@ -28,8 +28,8 @@
 
 @router.get(
     "/default",
+    description="Get default wallet\n\n" + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.7"),
     response_model=WalletGetWithAvailableCredits,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
     responses=WALLET_STATUS_CODES,
 )
 async def get_default_wallet(
@@ -41,8 +41,8 @@ async def get_default_wallet(
 @router.get(
     "/{wallet_id}",
     response_model=WalletGetWithAvailableCredits,
-    include_in_schema=API_SERVER_DEV_FEATURES_ENABLED,
     responses=WALLET_STATUS_CODES,
+    description="Get wallet\n\n" + FMSG_CHANGELOG_NEW_IN_VERSION.format("0.7"),
 )
 async def get_wallet(
     wallet_id: int,
