changed rest

Author: pcrespov

api/specs/web-server/_projects_groups.py

@@ -13,8 +13,10 @@
     ProjectPathParams,
 )
 from simcore_service_webserver.projects._controller.groups_rest import (
+    ProjectShareAccepted,
     _ProjectsGroupsBodyParams,
     _ProjectsGroupsPathParams,
+    _ProjectShare,
 )
 from simcore_service_webserver.projects._groups_service import ProjectGroupGet
 
@@ -26,12 +28,17 @@
 
 @router.post(
     "/projects/{project_id}:share",
-    response_model=Envelope[ProjectGroupGet],
-    status_code=status.HTTP_204_NO_CONTENT,
+    response_model=Envelope[ProjectShareAccepted],
+    status_code=status.HTTP_202_ACCEPTED,
+    responses={
+        status.HTTP_202_ACCEPTED: {
+            "description": "The request to share the project has been accepted, but the actual sharing process has to be confirmd."
+        }
+    },
 )
 async def share_project(
     _path: Annotated[ProjectPathParams, Depends()],
-    _body: _ProjectsGroupsBodyParams,
+    _body: _ProjectShare,
 ): ...
 
 

packages/models-library/src/models_library/api_schemas_webserver/groups.py

@@ -8,7 +8,9 @@
     AnyUrl,
     BaseModel,
     ConfigDict,
+    EmailStr,
     Field,
+    HttpUrl,
     TypeAdapter,
     ValidationError,
     field_validator,
@@ -383,3 +385,17 @@ class GroupUserUpdate(InputSchema):
             }
         }
     )
+
+
+class ProjectShare(InputSchema):
+    sharee_email: EmailStr
+
+    # sharing access
+    read: bool
+    write: bool
+    delete: bool
+
+
+class ProjectShareAccepted(OutputSchema):
+    sharee_email: EmailStr
+    confirmation_link: HttpUrl

services/web/server/src/simcore_service_webserver/projects/_controller/groups_rest.py

@@ -1,17 +1,21 @@
 import logging
 
 from aiohttp import web
-from models_library.api_schemas_webserver._base import InputSchema
+from models_library.api_schemas_webserver.groups import (
+    ProjectShare,
+    ProjectShareAccepted,
+)
 from models_library.basic_types import IDStr
 from models_library.groups import GroupID
 from models_library.projects import ProjectID
-from pydantic import BaseModel, ConfigDict, EmailStr, HttpUrl
+from pydantic import BaseModel, ConfigDict
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
 )
 from servicelib.logging_utils import log_context
+from simcore_service_webserver.login._login_service import envelope_response
 
 from ..._meta import api_version_prefix as VTAG
 from ...application_settings_utils import requires_dev_feature_enabled
@@ -30,18 +34,6 @@
 routes = web.RouteTableDef()
 
 
-class _ProjectShare(InputSchema):
-    # TODO: move to models_library.api_schemas_webserver.groups together with the rest
-    sharee_email: EmailStr
-
-    # sharing access
-    read: bool
-    write: bool
-    delete: bool
-
-    model_config = ConfigDict(extra="forbid")
-
-
 @routes.post(f"/{VTAG}/projects/{{project_id}}:share", name="share_project")
 @requires_dev_feature_enabled
 @login_required
@@ -50,7 +42,7 @@ class _ProjectShare(InputSchema):
 async def share_project(request: web.Request):
     req_ctx = RequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)
-    body_params = await parse_request_body_as(_ProjectShare, request)
+    body_params = await parse_request_body_as(ProjectShare, request)
 
     with log_context(
         _logger,
@@ -79,15 +71,16 @@ async def share_project(request: web.Request):
             request, code=confirmation_code
         )
 
-        assert HttpUrl(confirmation_link)  # nosec
-
         _logger.debug(
             "Send email with confirmation link %s to %s ",
             confirmation_link,
             body_params.sharee_email,
         )
 
-        return web.json_response(status=status.HTTP_204_NO_CONTENT)
+        return envelope_response(
+            data=ProjectShareAccepted(confirmation_link=confirmation_link),  # type: ignore
+            status=status.HTTP_202_ACCEPTED,
+        )
 
 
 class _ProjectsGroupsPathParams(BaseModel):

services/web/server/tests/unit/with_dbs/02/test_projects_groups_handlers.py

@@ -276,7 +276,10 @@ async def test_share_project(
             "delete": False,
         },
     )
-    await assert_status(resp, status.HTTP_204_NO_CONTENT)
+    data, error = await assert_status(resp, status.HTTP_202_ACCEPTED)
+    assert data["shareeEmail"] == "[email protected]"
+    assert data["confirmationLink"]
+    assert not error
 
     # Verify that only logged_user["primary_gid"] has access to the project
     url = client.app.router["list_project_groups"].url_for(