✨ web-api: exposes project's icon as an ui attribute (#7204)

Author: pcrespov

api/specs/web-server/_catalog.py

@@ -138,7 +138,7 @@ def get_service_resources(
 @router.get(
     "/catalog/services/{service_key:path}/{service_version}/pricing-plan",
     response_model=Envelope[ServicePricingPlanGet],
-    summary="Retrieve default pricing plan for provided service",
+    description="Retrieve default pricing plan for provided service",
     tags=["pricing-plans"],
 )
 async def get_service_pricing_plan(

api/specs/web-server/_diagnostics.py

@@ -36,7 +36,7 @@ async def healthcheck_liveness_probe():
 
 @router.get(
     "/config",
-    summary="Front end runtime configuration",
+    description="Front end runtime configuration",
     response_model=Envelope[dict[str, Any]],
 )
 async def get_config():
@@ -53,7 +53,7 @@ async def get_scheduled_maintenance():
 
 @router.get(
     "/status",
-    summary="checks status of self and connected services",
+    description="checks status of self and connected services",
     response_model=Envelope[AppStatusCheck],
     response_description="Returns app status check",
 )

api/specs/web-server/_folders.py

@@ -105,7 +105,7 @@ async def delete_folder(
 @router.post(
     "/folders/{folder_id}/workspaces/{workspace_id}:move",
     status_code=status.HTTP_204_NO_CONTENT,
-    summary="Move folder to the workspace",
+    description="Move folder to the workspace",
     tags=["workspaces"],
 )
 async def move_folder_to_workspace(

api/specs/web-server/_projects_crud.py renamed to api/specs/web-server/_projects.py

@@ -31,7 +31,7 @@
 from pydantic import BaseModel
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.projects._common.models import ProjectPathParams
-from simcore_service_webserver.projects._crud_handlers import ProjectCreateParams
+from simcore_service_webserver.projects._crud_handlers import ProjectCreateQueryParams
 from simcore_service_webserver.projects._crud_handlers_models import (
     ProjectActiveQueryParams,
     ProjectsListQueryParams,
@@ -67,12 +67,14 @@ class _ProjectCreateHeaderParams(BaseModel):
 @router.post(
     "/projects",
     response_model=Envelope[TaskGet],
-    summary="Creates a new project or copies an existing one",
-    status_code=status.HTTP_201_CREATED,
+    description="Creates a new project or copies an existing one. "
+    "NOTE: implemented as a long running task, "
+    "i.e. requires polling `status_href` (HTTP_200_OK) to get status and `result_href` (HTTP_201_CREATED) to get created project",
+    status_code=status.HTTP_202_ACCEPTED,
 )
 async def create_project(
     _h: Annotated[_ProjectCreateHeaderParams, Depends()],
-    _path: Annotated[ProjectCreateParams, Depends()],
+    _path: Annotated[ProjectCreateQueryParams, Depends()],
     _body: ProjectCreateNew | ProjectCopyOverride,
 ):
     ...

api/specs/web-server/_projects_comments.py

@@ -40,7 +40,7 @@
 @router.post(
     "/projects/{project_uuid}/comments",
     response_model=Envelope[dict[Literal["comment_id"], CommentID]],
-    summary="Create a new comment for a specific project. The request body should contain the comment contents and user information.",
+    description="Create a new comment for a specific project. The request body should contain the comment contents and user information.",
     status_code=201,
 )
 async def create_project_comment(
@@ -57,7 +57,7 @@ async def create_project_comment(
 @router.get(
     "/projects/{project_uuid}/comments",
     response_model=Envelope[list[ProjectsCommentsAPI]],
-    summary="Retrieve all comments for a specific project.",
+    description="Retrieve all comments for a specific project.",
 )
 async def list_project_comments(
     project_uuid: ProjectID, limit: int = 20, offset: NonNegativeInt = 0
@@ -73,7 +73,7 @@ async def list_project_comments(
 @router.put(
     "/projects/{project_uuid}/comments/{comment_id}",
     response_model=Envelope[ProjectsCommentsAPI],
-    summary="Update the contents of a specific comment for a project. The request body should contain the updated comment contents.",
+    description="Update the contents of a specific comment for a project. The request body should contain the updated comment contents.",
 )
 async def update_project_comment(
     project_uuid: ProjectID,
@@ -90,7 +90,7 @@ async def update_project_comment(
 
 @router.delete(
     "/projects/{project_uuid}/comments/{comment_id}",
-    summary="Delete a specific comment associated with a project.",
+    description="Delete a specific comment associated with a project.",
     status_code=204,
 )
 async def delete_project_comment(project_uuid: ProjectID, comment_id: CommentID):
@@ -105,7 +105,7 @@ async def delete_project_comment(project_uuid: ProjectID, comment_id: CommentID)
 @router.get(
     "/projects/{project_uuid}/comments/{comment_id}",
     response_model=Envelope[ProjectsCommentsAPI],
-    summary="Retrieve a specific comment by its ID within a project.",
+    description="Retrieve a specific comment by its ID within a project.",
 )
 async def get_project_comment(project_uuid: ProjectID, comment_id: CommentID):
     ...

api/specs/web-server/_projects_folders.py

@@ -26,7 +26,7 @@
 @router.put(
     "/projects/{project_id}/folders/{folder_id}",
     status_code=status.HTTP_204_NO_CONTENT,
-    summary="Move project to the folder",
+    description="Move project to the folder",
 )
 async def replace_project_folder(
     _path: Annotated[_ProjectsFoldersPathParams, Depends()],

api/specs/web-server/_projects_nodes.py

@@ -159,7 +159,7 @@ def replace_node_resources(
 @router.get(
     "/projects/{project_id}/nodes/-/services:access",
     response_model=Envelope[_ProjectGroupAccess],
-    summary="Check whether provided group has access to the project services",
+    description="Check whether provided group has access to the project services",
 )
 async def get_project_services_access_for_gid(
     project_id: ProjectID, for_gid: GroupID  # noqa: ARG001
@@ -180,7 +180,7 @@ async def get_project_services_access_for_gid(
 @router.get(
     "/projects/{project_id}/nodes/-/preview",
     response_model=Envelope[list[_ProjectNodePreview]],
-    summary="Lists all previews in the node's project",
+    description="Lists all previews in the node's project",
 )
 async def list_project_nodes_previews(project_id: ProjectID):  # noqa: ARG001
     ...
@@ -192,7 +192,7 @@ async def list_project_nodes_previews(project_id: ProjectID):  # noqa: ARG001
 @router.get(
     "/projects/{project_id}/nodes/{node_id}/preview",
     response_model=Envelope[_ProjectNodePreview],
-    summary="Gets a give node's preview",
+    description="Gets a give node's preview",
     responses={status.HTTP_404_NOT_FOUND: {"description": "Node has no preview"}},
 )
 async def get_project_node_preview(

api/specs/web-server/_projects_nodes_pricing_unit.py

@@ -33,7 +33,7 @@
 @router.get(
     "/projects/{project_id}/nodes/{node_id}/pricing-unit",
     response_model=Envelope[PricingUnitGet | None],
-    summary="Get currently connected pricing unit to the project node.",
+    description="Get currently connected pricing unit to the project node.",
 )
 async def get_project_node_pricing_unit(project_id: ProjectID, node_id: NodeID):
     ...
@@ -44,7 +44,7 @@ async def get_project_node_pricing_unit(project_id: ProjectID, node_id: NodeID):
 
 @router.put(
     "/projects/{project_id}/nodes/{node_id}/pricing-plan/{pricing_plan_id}/pricing-unit/{pricing_unit_id}",
-    summary="Connect pricing unit to the project node (Project node can have only one pricing unit)",
+    description="Connect pricing unit to the project node (Project node can have only one pricing unit)",
     status_code=status.HTTP_204_NO_CONTENT,
 )
 async def connect_pricing_unit_to_project_node(

api/specs/web-server/_projects_wallet.py

@@ -34,7 +34,7 @@
 @router.get(
     "/projects/{project_id}/wallet",
     response_model=Envelope[WalletGet | None],
-    summary="Get current connected wallet to the project.",
+    description="Get current connected wallet to the project.",
 )
 async def get_project_wallet(project_id: ProjectID):
     ...
@@ -46,7 +46,7 @@ async def get_project_wallet(project_id: ProjectID):
 @router.put(
     "/projects/{project_id}/wallet/{wallet_id}",
     response_model=Envelope[WalletGet],
-    summary="Connect wallet to the project (Project can have only one wallet)",
+    description="Connect wallet to the project (Project can have only one wallet)",
 )
 async def connect_wallet_to_project(
     project_id: ProjectID,

api/specs/web-server/_projects_workspaces.py

@@ -26,7 +26,7 @@
 @router.post(
     "/projects/{project_id}/workspaces/{workspace_id}:move",
     status_code=status.HTTP_204_NO_CONTENT,
-    summary="Move project to the workspace",
+    description="Move project to the workspace",
 )
 async def move_project_to_workspace(
     _path: Annotated[_ProjectWorkspacesPathParams, Depends()],