review @pcrespov

Author: matusdrobuliak66

api/specs/web-server/_projects_comments.py

@@ -11,7 +11,7 @@
 from typing import Literal
 
 from _common import assert_handler_signature_against_model
-from fastapi import APIRouter
+from fastapi import APIRouter, status
 from models_library.generics import Envelope
 from models_library.projects import ProjectID
 from models_library.projects_comments import CommentID, ProjectsCommentsAPI
@@ -41,7 +41,7 @@
     "/projects/{project_uuid}/comments",
     response_model=Envelope[dict[Literal["comment_id"], CommentID]],
     description="Create a new comment for a specific project. The request body should contain the comment contents and user information.",
-    status_code=201,
+    status_code=status.HTTP_201_CREATED,
     deprecated=True,
 )
 async def create_project_comment(
@@ -91,7 +91,7 @@ async def update_project_comment(
 @router.delete(
     "/projects/{project_uuid}/comments/{comment_id}",
     description="Delete a specific comment associated with a project.",
-    status_code=204,
+    status_code=status.HTTP_204_NO_CONTENT,
     deprecated=True,
 )
 async def delete_project_comment(project_uuid: ProjectID, comment_id: CommentID): ...

api/specs/web-server/_projects_conversations.py

@@ -9,23 +9,34 @@
 # pylint: disable=too-many-arguments
 
 
-from _common import assert_handler_signature_against_model
-from fastapi import APIRouter
+from typing import Annotated
+
+from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.projects_conversations import (
     ConversationMessageRestGet,
     ConversationRestGet,
 )
-from models_library.conversations import ConversationID, ConversationMessageID
 from models_library.generics import Envelope
-from models_library.projects import ProjectID
 from models_library.rest_pagination import Page
-from pydantic import NonNegativeInt
 from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.projects._controller._rest_schemas import (
+    ProjectPathParams,
+)
+
+# from simcore_service_webserver.projects._controller.conversations_rest import (
+#     _ProjectConversationsPathParams,
+#     _ListProjectConversationMessagesQueryParams,
+#     _ProjectConversationMessagesCreateBodyParams,
+#     _ProjectConversationMessagesPutBodyParams,
+# )
 from simcore_service_webserver.projects._controller.conversations_rest import (
+    _ListProjectConversationMessagesQueryParams,
     _ListProjectConversationsQueryParams,
     _ProjectConversationMessagesCreateBodyParams,
     _ProjectConversationMessagesPutBodyParams,
     _ProjectConversationsCreateBodyParams,
+    _ProjectConversationsMessagesPathParams,
+    _ProjectConversationsPathParams,
     _ProjectConversationsPutBodyParams,
 )
 
@@ -46,10 +57,11 @@
 @router.post(
     "/projects/{project_id}/conversations",
     response_model=Envelope[ConversationRestGet],
-    status_code=201,
+    status_code=status.HTTP_201_CREATED,
 )
 async def create_project_conversation(
-    project_id: ProjectID, body: _ProjectConversationsCreateBodyParams
+    _params: Annotated[ProjectPathParams, Depends()],
+    _body: _ProjectConversationsCreateBodyParams,
 ): ...
 
 
@@ -58,32 +70,27 @@ async def create_project_conversation(
     response_model=Page[ConversationRestGet],
 )
 async def list_project_conversations(
-    project_id: ProjectID, limit: int = 20, offset: NonNegativeInt = 0
+    _params: Annotated[ProjectPathParams, Depends()],
+    _query: Annotated[_ListProjectConversationsQueryParams, Depends()],
 ): ...
 
 
-assert_handler_signature_against_model(
-    list_project_conversations, _ListProjectConversationsQueryParams
-)
-
-
 @router.put(
     "/projects/{project_id}/conversations/{conversation_id}",
     response_model=Envelope[ConversationRestGet],
 )
 async def update_project_conversation(
-    project_id: ProjectID,
-    conversation_id: ConversationID,
-    body: _ProjectConversationsPutBodyParams,
+    _params: Annotated[_ProjectConversationsPathParams, Depends()],
+    _body: _ProjectConversationsPutBodyParams,
 ): ...
 
 
 @router.delete(
     "/projects/{project_id}/conversations/{conversation_id}",
-    status_code=204,
+    status_code=status.HTTP_204_NO_CONTENT,
 )
 async def delete_project_conversation(
-    project_id: ProjectID, conversation_id: ConversationID
+    _params: Annotated[_ProjectConversationsPathParams, Depends()],
 ): ...
 
 
@@ -92,19 +99,21 @@ async def delete_project_conversation(
     response_model=Envelope[ConversationRestGet],
 )
 async def get_project_conversation(
-    project_id: ProjectID, conversation_id: ConversationID
+    _params: Annotated[_ProjectConversationsPathParams, Depends()],
 ): ...
 
 
+### Conversation Messages
+
+
 @router.post(
     "/projects/{project_id}/conversations/{conversation_id}/messages",
     response_model=Envelope[ConversationMessageRestGet],
-    status_code=201,
+    status_code=status.HTTP_201_CREATED,
 )
 async def create_project_conversation_message(
-    project_id: ProjectID,
-    conversation_id: ConversationID,
-    body: _ProjectConversationMessagesCreateBodyParams,
+    _params: Annotated[_ProjectConversationsPathParams, Depends()],
+    _body: _ProjectConversationMessagesCreateBodyParams,
 ): ...
 
 
@@ -113,10 +122,8 @@ async def create_project_conversation_message(
     response_model=Page[ConversationMessageRestGet],
 )
 async def list_project_conversation_messages(
-    project_id: ProjectID,
-    conversation_id: ConversationID,
-    limit: int = 20,
-    offset: NonNegativeInt = 0,
+    _params: Annotated[_ProjectConversationsPathParams, Depends()],
+    _query: Annotated[_ListProjectConversationMessagesQueryParams, Depends()],
 ): ...
 
 
@@ -125,21 +132,17 @@ async def list_project_conversation_messages(
     response_model=Envelope[ConversationMessageRestGet],
 )
 async def update_project_conversation_message(
-    project_id: ProjectID,
-    conversation_id: ConversationID,
-    message_id: ConversationMessageID,
-    body: _ProjectConversationMessagesPutBodyParams,
+    _params: Annotated[_ProjectConversationsMessagesPathParams, Depends()],
+    _body: _ProjectConversationMessagesPutBodyParams,
 ): ...
 
 
 @router.delete(
     "/projects/{project_id}/conversations/{conversation_id}/messages/{message_id}",
-    status_code=204,
+    status_code=status.HTTP_204_NO_CONTENT,
 )
 async def delete_project_conversation_message(
-    project_id: ProjectID,
-    conversation_id: ConversationID,
-    message_id: ConversationMessageID,
+    _params: Annotated[_ProjectConversationsMessagesPathParams, Depends()],
 ): ...
 
 
@@ -148,7 +151,5 @@ async def delete_project_conversation_message(
     response_model=Envelope[ConversationMessageRestGet],
 )
 async def get_project_conversation_message(
-    project_id: ProjectID,
-    conversation_id: ConversationID,
-    message_id: ConversationMessageID,
+    _params: Annotated[_ProjectConversationsMessagesPathParams, Depends()],
 ): ...

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

@@ -16,6 +16,8 @@
 from ..projects import ProjectID
 from ._base import InputSchema, OutputSchema
 
+### PROJECT CONVERSATION -------------------------------------------------------------------
+
 
 class ConversationRestGet(OutputSchema):
     conversation_id: ConversationID
@@ -41,6 +43,13 @@ def from_domain_model(cls, domain: ConversationDB) -> Self:
         )
 
 
+class ConversationPatch(InputSchema):
+    name: str | None = None
+
+
+###  PROJECT CONVERSATION MESSAGES ---------------------------------------------------------------
+
+
 class ConversationMessageRestGet(OutputSchema):
     message_id: ConversationMessageID
     conversation_id: ConversationID
@@ -63,9 +72,5 @@ def from_domain_model(cls, domain: ConversationMessageDB) -> Self:
         )
 
 
-class ConversationPatch(InputSchema):
-    name: str | None = None
-
-
 class ConversationMessagePatch(InputSchema):
     content: str | None = None

packages/postgres-database/src/simcore_postgres_database/models/conversations.py

@@ -28,7 +28,6 @@ class ConversationType(enum.Enum):
         "name",
         sa.String,
         nullable=False,
-        doc="project reference for this table",
     ),
     sa.Column(
         "project_uuid",

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

@@ -4865,8 +4865,11 @@ paths:
         required: false
         schema:
           type: integer
+          minimum: 1
+          exclusiveMaximum: true
           default: 20
           title: Limit
+          maximum: 50
       - name: offset
         in: query
         required: false
@@ -5030,8 +5033,11 @@ paths:
         required: false
         schema:
           type: integer
+          minimum: 1
+          exclusiveMaximum: true
           default: 20
           title: Limit
+          maximum: 50
       - name: offset
         in: query
         required: false
@@ -17136,7 +17142,6 @@ components:
           title: Name
         type:
           $ref: '#/components/schemas/ConversationType'
-      additionalProperties: false
       type: object
       required:
       - name
@@ -17147,7 +17152,6 @@ components:
         name:
           type: string
           title: Name
-      additionalProperties: false
       type: object
       required:
       - name

services/web/server/src/simcore_service_webserver/conversations/errors.py

@@ -1,12 +1,12 @@
 from ..errors import WebServerBaseError
 
 
-class ConbersationError(WebServerBaseError, ValueError): ...
+class ConversationError(WebServerBaseError, ValueError): ...
 
 
-class ConversationErrorNotFoundError(ConbersationError):
+class ConversationErrorNotFoundError(ConversationError):
     msg_template = "Conversation {conversation_id} not found"
 
 
-class ConversationMessageErrorNotFoundError(ConbersationError):
+class ConversationMessageErrorNotFoundError(ConversationError):
     msg_template = "Conversation {conversation_id} message {message_id} not found"

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

@@ -1,6 +1,7 @@
 import logging
 
 from aiohttp import web
+from models_library.api_schemas_webserver._base import InputSchema
 from models_library.api_schemas_webserver.projects_conversations import (
     ConversationMessageRestGet,
     ConversationRestGet,
@@ -11,14 +12,12 @@
     ConversationMessageType,
     ConversationType,
 )
-from models_library.projects import ProjectID
 from models_library.rest_pagination import (
-    DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
-    MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
     Page,
+    PageQueryParameters,
 )
 from models_library.rest_pagination_utils import paginate_data
-from pydantic import BaseModel, ConfigDict, Field, NonNegativeInt
+from pydantic import BaseModel, ConfigDict
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
@@ -46,34 +45,20 @@
 #
 
 
-class _ProjectConversationsPathParams(BaseModel):
-    project_id: ProjectID
+class _ProjectConversationsPathParams(ProjectPathParams):
     conversation_id: ConversationID
-    model_config = ConfigDict(extra="forbid")
 
 
-class _ListProjectConversationsQueryParams(BaseModel):
-    limit: int = Field(
-        default=DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
-        description="maximum number of items to return (pagination)",
-        ge=1,
-        lt=MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
-    )
-    offset: NonNegativeInt = Field(
-        default=0, description="index to the first item to return (pagination)"
-    )
-    model_config = ConfigDict(extra="forbid")
+class _ListProjectConversationsQueryParams(PageQueryParameters): ...
 
 
-class _ProjectConversationsCreateBodyParams(BaseModel):
+class _ProjectConversationsCreateBodyParams(InputSchema):
     name: str
     type: ConversationType
-    model_config = ConfigDict(extra="forbid")
 
 
-class _ProjectConversationsPutBodyParams(BaseModel):
+class _ProjectConversationsPutBodyParams(InputSchema):
     name: str
-    model_config = ConfigDict(extra="forbid")
 
 
 @routes.post(
@@ -225,23 +210,12 @@ async def get_project_conversation(request: web.Request):
 #
 
 
-class _ProjectConversationsMessagesPathParams(BaseModel):
-    project_id: ProjectID
-    conversation_id: ConversationID
+class _ProjectConversationsMessagesPathParams(_ProjectConversationsPathParams):
     message_id: ConversationMessageID
     model_config = ConfigDict(extra="forbid")
 
 
-class _ListProjectConversationMessagesQueryParams(BaseModel):
-    limit: int = Field(
-        default=DEFAULT_NUMBER_OF_ITEMS_PER_PAGE,
-        description="maximum number of items to return (pagination)",
-        ge=1,
-        lt=MAXIMUM_NUMBER_OF_ITEMS_PER_PAGE,
-    )
-    offset: NonNegativeInt = Field(
-        default=0, description="index to the first item to return (pagination)"
-    )
+class _ListProjectConversationMessagesQueryParams(PageQueryParameters):
     model_config = ConfigDict(extra="forbid")
 
 

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

@@ -19,7 +19,7 @@
 from ..conversations import conversations_service
 from ._access_rights_service import check_user_project_permission
 
-log = logging.getLogger(__name__)
+_logger = logging.getLogger(__name__)
 
 
 #