fix: oas

Author: giancarloromeo

api/specs/web-server/_long_running_tasks.py

@@ -13,7 +13,7 @@
 from servicelib.long_running_tasks.models import TaskGet, TaskStatus
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.tasks._exception_handlers import (
-    _TO_HTTP_ERROR_MAP as export_data_http_error_map,
+    _TO_HTTP_ERROR_MAP,
 )
 
 router = APIRouter(
@@ -23,16 +23,15 @@
     ],
 )
 
-_export_data_responses: dict[int | str, dict[str, Any]] = {
-    i.status_code: {"model": EnvelopedError}
-    for i in export_data_http_error_map.values()
+_responses: dict[int | str, dict[str, Any]] = {
+    i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
 }
 
 
 @router.get(
     "/tasks",
     response_model=Envelope[list[TaskGet]],
-    responses=_export_data_responses,
+    responses=_responses,
 )
 def get_async_jobs():
     """Lists all long running tasks"""
@@ -41,7 +40,7 @@ def get_async_jobs():
 @router.get(
     "/tasks/{task_id}",
     response_model=Envelope[TaskStatus],
-    responses=_export_data_responses,
+    responses=_responses,
 )
 def get_async_job_status(
     _path_params: Annotated[_PathParam, Depends()],
@@ -51,7 +50,7 @@ def get_async_job_status(
 
 @router.delete(
     "/tasks/{task_id}",
-    responses=_export_data_responses,
+    responses=_responses,
     status_code=status.HTTP_204_NO_CONTENT,
 )
 def cancel_async_job(
@@ -63,7 +62,7 @@ def cancel_async_job(
 @router.get(
     "/tasks/{task_id}/result",
     response_model=Any,
-    responses=_export_data_responses,
+    responses=_responses,
 )
 def get_async_job_result(
     _path_params: Annotated[_PathParam, Depends()],

api/specs/web-server/_storage.py

@@ -7,9 +7,7 @@
 from typing import Annotated, Any, TypeAlias
 
 from fastapi import APIRouter, Depends, Query, status
-from models_library.api_schemas_long_running_tasks.tasks import (
-    TaskGet,
-)
+from models_library.api_schemas_long_running_tasks.tasks import TaskGet
 from models_library.api_schemas_storage.storage_schemas import (
     FileLocation,
     FileMetaDataGet,
@@ -25,9 +23,9 @@
     BatchDeletePathsBodyParams,
     DataExportPost,
     ListPathsQueryParams,
+    SearchBodyParams,
     StorageLocationPathParams,
     StoragePathComputeSizeParams,
-    SearchBodyParams
 )
 from models_library.generics import Envelope
 from models_library.projects_nodes_io import LocationID
@@ -37,7 +35,7 @@
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.storage.schemas import DatasetMetaData, FileMetaData
 from simcore_service_webserver.tasks._exception_handlers import (
-    _TO_HTTP_ERROR_MAP as export_data_http_error_map,
+    _TO_HTTP_ERROR_MAP,
 )
 
 router = APIRouter(
@@ -221,29 +219,30 @@ async def is_completed_upload_file(
     """Returns state of upload completion"""
 
 
-# data export
-_export_data_responses: dict[int | str, dict[str, Any]] = {
-    i.status_code: {"model": EnvelopedError}
-    for i in export_data_http_error_map.values()
+_responses: dict[int | str, dict[str, Any]] = {
+    i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
 }
 
 
 @router.post(
     "/storage/locations/{location_id}/export-data",
+    status_code=status.HTTP_202_ACCEPTED,
     response_model=Envelope[TaskGet],
     name="export_data",
     description="Export data",
-    responses=_export_data_responses,
+    responses=_responses,
 )
 async def export_data(export_data: DataExportPost, location_id: LocationID):
     """Trigger data export. Returns async job id for getting status and results"""
 
 
 @router.post(
     "/storage/locations/{location_id}/search",
+    status_code=status.HTTP_202_ACCEPTED,
     response_model=Envelope[TaskGet],
     name="search",
     description="Starts a files/folders search",
+    responses=_responses,
 )
 async def search(
     _path: Annotated[StorageLocationPathParams, Depends()],

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -7939,7 +7939,7 @@ paths:
             schema:
               $ref: '#/components/schemas/DataExportPost'
       responses:
-        '200':
+        '202':
           description: Successful Response
           content:
             application/json:
@@ -7974,7 +7974,7 @@ paths:
       tags:
       - storage
       summary: Search
-      description: Search
+      description: Starts a files/folders search
       operationId: search
       parameters:
       - name: location_id
@@ -7990,12 +7990,36 @@ paths:
             schema:
               $ref: '#/components/schemas/SearchBodyParams'
       responses:
-        '200':
+        '202':
           description: Successful Response
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Envelope_TaskGet_'
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnvelopedError'
+          description: Not Found
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnvelopedError'
+          description: Forbidden
+        '410':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnvelopedError'
+          description: Gone
+        '500':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnvelopedError'
+          description: Internal Server Error
   /v0/trash:empty:
     post:
       tags:

services/web/server/src/simcore_service_webserver/storage/_rest.py

@@ -47,7 +47,10 @@
 from servicelib.rabbitmq.rpc_interfaces.storage.paths import (
     delete_paths as remote_delete_paths,
 )
-from servicelib.rabbitmq.rpc_interfaces.storage.simcore_s3 import start_export_data, start_search
+from servicelib.rabbitmq.rpc_interfaces.storage.simcore_s3 import (
+    start_export_data,
+    start_search,
+)
 from servicelib.request_keys import RQT_USERID_KEY
 from servicelib.rest_responses import unwrap_envelope
 from yarl import URL
@@ -57,7 +60,7 @@
 from ..models import AuthenticatedRequestContext
 from ..rabbitmq import get_rabbitmq_rpc_client
 from ..security.decorators import permission_required
-from ..tasks._exception_handlers import handle_export_data_exceptions
+from ..tasks._exception_handlers import handle_exceptions
 from ..utils import get_job_filter
 from .schemas import StorageFileIDStr
 from .settings import StorageSettings, get_plugin_settings
@@ -481,7 +484,7 @@ class _PathParams(BaseModel):
 )
 @login_required
 @permission_required("storage.files.*")
-@handle_export_data_exceptions
+@handle_exceptions
 async def export_data(request: web.Request) -> web.Response:
     class _PathParams(BaseModel):
         location_id: LocationID
@@ -521,12 +524,10 @@ def allow_only_simcore(cls, v: int) -> int:
     )
 
 
-@routes.post(
-    _storage_locations_prefix + "/{location_id}/search", name="search"
-)
+@routes.post(_storage_locations_prefix + "/{location_id}/search", name="search")
 @login_required
 @permission_required("storage.files.*")
-@handle_export_data_exceptions
+@handle_exceptions
 async def search(request: web.Request) -> web.Response:
     class _PathParams(BaseModel):
         location_id: LocationID

services/web/server/src/simcore_service_webserver/tasks/_exception_handlers.py

@@ -69,6 +69,6 @@
 }
 
 
-handle_export_data_exceptions = exception_handling_decorator(
+handle_exceptions = exception_handling_decorator(
     to_exceptions_handlers_map(_TO_HTTP_ERROR_MAP)
 )

services/web/server/src/simcore_service_webserver/tasks/_rest.py

@@ -37,7 +37,7 @@
 from ..rabbitmq import get_rabbitmq_rpc_client
 from ..security.decorators import permission_required
 from ..utils import get_job_filter
-from ._exception_handlers import handle_export_data_exceptions
+from ._exception_handlers import handle_exceptions
 
 log = logging.getLogger(__name__)
 
@@ -53,7 +53,7 @@
 )
 @login_required
 @permission_required("storage.files.*")
-@handle_export_data_exceptions
+@handle_exceptions
 @webserver_request_context_decorator
 async def get_async_jobs(request: web.Request) -> web.Response:
     inprocess_long_running_manager = get_long_running_manager(request.app)
@@ -108,7 +108,7 @@ class _StorageAsyncJobId(BaseModel):
     name="get_async_job_status",
 )
 @login_required
-@handle_export_data_exceptions
+@handle_exceptions
 async def get_async_job_status(request: web.Request) -> web.Response:
 
     _req_ctx = AuthenticatedRequestContext.model_validate(request)
@@ -143,7 +143,7 @@ async def get_async_job_status(request: web.Request) -> web.Response:
 )
 @login_required
 @permission_required("storage.files.*")
-@handle_export_data_exceptions
+@handle_exceptions
 async def cancel_async_job(request: web.Request) -> web.Response:
 
     _req_ctx = AuthenticatedRequestContext.model_validate(request)
@@ -170,7 +170,7 @@ async def cancel_async_job(request: web.Request) -> web.Response:
 )
 @login_required
 @permission_required("storage.files.*")
-@handle_export_data_exceptions
+@handle_exceptions
 async def get_async_job_result(request: web.Request) -> web.Response:
     class _PathParams(BaseModel):
         task_id: UUID