improves OAS

Author: pcrespov

api/specs/web-server/_trash.py

@@ -5,10 +5,14 @@
 
 
 from enum import Enum
+from typing import Annotated
 
-from fastapi import APIRouter, status
-from models_library.projects import ProjectID
+from fastapi import APIRouter, Depends, status
 from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.projects._trash_handlers import (
+    ProjectPathParams,
+    RemoveQueryParams,
+)
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -33,7 +37,8 @@ def empty_trash():
     status_code=status.HTTP_204_NO_CONTENT,
 )
 def trash_project(
-    project_id: ProjectID,
+    _p: Annotated[ProjectPathParams, Depends()],
+    _q: Annotated[RemoveQueryParams, Depends()],
 ):
     ...
 
@@ -44,6 +49,6 @@ def trash_project(
     status_code=status.HTTP_204_NO_CONTENT,
 )
 def untrash_project(
-    project_id: ProjectID,
+    _p: Annotated[ProjectPathParams, Depends()],
 ):
     ...

services/web/server/src/simcore_service_webserver/projects/_common_models.py

@@ -23,3 +23,9 @@ class ProjectPathParams(BaseModel):
     class Config:
         allow_population_by_field_name = True
         extra = Extra.forbid
+
+
+class RemoveQueryParams(BaseModel):
+    force: bool = Field(
+        default=True, description="Force removal (even if resource is active)"
+    )

services/web/server/src/simcore_service_webserver/projects/_trash_api.py

@@ -50,12 +50,21 @@ async def trash_project(
     user_id: UserID,
     project_id: ProjectID,
     trashed: bool,
-    forced: bool = True,
+    forced: bool = False,
 ):
+    """_summary_
+
+    Keyword Arguments:
+        forced -- _description_ (default: {False})
+
+    Raises:
+        ProjectStopError: _description_
+        ProjectRunningConflictError: if
+    """
     if trashed:
-        # stop first
 
         if forced:
+            # stop first
             try:
                 await projects_api.remove_project_dynamic_services(
                     user_id=user_id,
@@ -76,11 +85,10 @@ async def trash_project(
                     from_err=exc,
                 ) from exc
         else:
-
+            # NOTE: must do here as well for dynamic services but needs refactoring!
             running = await director_v2_api.is_pipeline_running(
                 app=app, user_id=user_id, project_id=project_id
             )
-            # NOTE: must do here as well for dynamic services but needs refactoring!
             if running:
                 raise ProjectRunningConflictError(
                     project_uuid=project_id,

services/web/server/src/simcore_service_webserver/projects/_trash_handlers.py

@@ -4,7 +4,10 @@
 
 from aiohttp import web
 from servicelib.aiohttp import status
-from servicelib.aiohttp.requests_validation import parse_request_path_parameters_as
+from servicelib.aiohttp.requests_validation import (
+    parse_request_path_parameters_as,
+    parse_request_query_parameters_as,
+)
 from servicelib.aiohttp.typing_extension import Handler
 from servicelib.aiohttp.web_exceptions_extension import get_http_error_class_or_none
 from servicelib.logging_errors import create_troubleshotting_log_kwargs
@@ -16,6 +19,7 @@
 from ..projects._common_models import ProjectPathParams
 from ..security.decorators import permission_required
 from . import _trash_api
+from ._common_models import RemoveQueryParams
 from .exceptions import ProjectRunningConflictError, ProjectStopError, ProjectTrashError
 
 _logger = logging.getLogger(__name__)
@@ -116,13 +120,15 @@ async def trash_project(request: web.Request):
     user_id = get_user_id(request)
     product_name = get_product_name(request)
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)
+    query_params = parse_request_query_parameters_as(RemoveQueryParams, request)
 
     await _trash_api.trash_project(
         request.app,
         product_name=product_name,
         user_id=user_id,
         project_id=path_params.project_id,
         trashed=True,
+        forced=query_params.force,
     )
 
     return web.json_response(status=status.HTTP_204_NO_CONTENT)