oas

Author: pcrespov

api/specs/web-server/_auth.py

@@ -6,7 +6,7 @@
 
 from typing import Any
 
-from _common import Error, Log
+from _common import EnvelopeE
 from fastapi import APIRouter, status
 from models_library.api_schemas_webserver.auth import (
     AccountRequestInfo,
@@ -15,6 +15,7 @@
     UnregisterCheck,
 )
 from models_library.generics import Envelope
+from models_library.rest_error import ErrorGet, Log
 from pydantic import BaseModel, Field, confloat
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.login._2fa_handlers import Resend2faBody
@@ -75,7 +76,7 @@ async def register(_body: RegisterBody):
     "/auth/unregister",
     response_model=Envelope[Log],
     status_code=status.HTTP_200_OK,
-    responses={status.HTTP_409_CONFLICT: {"model": Envelope[Error]}},
+    responses={status.HTTP_409_CONFLICT: {"model": EnvelopeE[ErrorGet]}},
 )
 async def unregister_account(_body: UnregisterCheck):
     ...
@@ -107,7 +108,7 @@ async def phone_confirmation(_body: PhoneConfirmationBody):
     responses={
         # status.HTTP_503_SERVICE_UNAVAILABLE
         status.HTTP_401_UNAUTHORIZED: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unauthorized reset due to invalid token code",
         }
     },
@@ -122,7 +123,7 @@ async def login(_body: LoginBody):
     operation_id="auth_login_2fa",
     responses={
         status.HTTP_401_UNAUTHORIZED: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unauthorized reset due to invalid token code",
         }
     },
@@ -137,7 +138,7 @@ async def login_2fa(_body: LoginTwoFactorAuthBody):
     operation_id="auth_resend_2fa_code",
     responses={
         status.HTTP_401_UNAUTHORIZED: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unauthorized reset due to invalid token code",
         }
     },
@@ -161,7 +162,7 @@ async def logout(_body: LogoutBody):
     status_code=status.HTTP_204_NO_CONTENT,
     responses={
         status.HTTP_401_UNAUTHORIZED: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unauthorized reset due to invalid token code",
         }
     },
@@ -174,7 +175,7 @@ async def check_auth():
     "/auth/reset-password",
     response_model=Envelope[Log],
     operation_id="auth_reset_password",
-    responses={status.HTTP_503_SERVICE_UNAVAILABLE: {"model": Envelope[Error]}},
+    responses={status.HTTP_503_SERVICE_UNAVAILABLE: {"model": EnvelopeE[ErrorGet]}},
 )
 async def reset_password(_body: ResetPasswordBody):
     """a non logged-in user requests a password reset"""
@@ -186,7 +187,7 @@ async def reset_password(_body: ResetPasswordBody):
     operation_id="auth_reset_password_allowed",
     responses={
         status.HTTP_401_UNAUTHORIZED: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unauthorized reset due to invalid token code",
         }
     },
@@ -201,11 +202,11 @@ async def reset_password_allowed(code: str, _body: ResetPasswordConfirmation):
     operation_id="auth_change_email",
     responses={
         status.HTTP_401_UNAUTHORIZED: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unauthorized user. Login required",
         },
         status.HTTP_503_SERVICE_UNAVAILABLE: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unable to send confirmation email",
         },
     },
@@ -233,15 +234,15 @@ class PasswordCheckSchema(BaseModel):
     operation_id="auth_change_password",
     responses={
         status.HTTP_401_UNAUTHORIZED: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "unauthorized user. Login required",
         },
         status.HTTP_409_CONFLICT: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "mismatch between new and confirmation passwords",
         },
         status.HTTP_422_UNPROCESSABLE_ENTITY: {
-            "model": Envelope[Error],
+            "model": EnvelopeE[ErrorGet],
             "description": "current password is invalid",
         },
     },

api/specs/web-server/_common.py

@@ -5,13 +5,22 @@
 import sys
 from collections.abc import Callable
 from pathlib import Path
-from typing import Annotated, NamedTuple, Optional, Union, get_args, get_origin
+from typing import (
+    Annotated,
+    Any,
+    Generic,
+    NamedTuple,
+    Optional,
+    TypeVar,
+    Union,
+    get_args,
+    get_origin,
+)
 
 from common_library.json_serialization import json_dumps
 from common_library.pydantic_fields_extension import get_type
 from fastapi import Query
-from models_library.basic_types import LogLevel
-from pydantic import BaseModel, ConfigDict, Field, Json, create_model
+from pydantic import BaseModel, Json, create_model
 from pydantic.fields import FieldInfo
 
 CURRENT_DIR = Path(sys.argv[0] if __name__ == "__main__" else __file__).resolve().parent
@@ -78,43 +87,14 @@ def as_query(model_class: type[BaseModel]) -> type[BaseModel]:
     return create_model(new_model_name, **fields)
 
 
-class Log(BaseModel):
-    level: LogLevel | None = Field("INFO", description="log level")
-    message: str = Field(
-        ...,
-        description="log message. If logger is USER, then it MUST be human readable",
-    )
-    logger: str | None = Field(
-        None, description="name of the logger receiving this message"
-    )
-
-    model_config = ConfigDict(
-        json_schema_extra={
-            "example": {
-                "message": "Hi there, Mr user",
-                "level": "INFO",
-                "logger": "user-logger",
-            }
-        }
-    )
-
+ErrorT = TypeVar("ErrorT")
 
-class ErrorItem(BaseModel):
-    code: str = Field(
-        ...,
-        description="Typically the name of the exception that produced it otherwise some known error code",
-    )
-    message: str = Field(..., description="Error message specific to this item")
-    resource: str | None = Field(
-        None, description="API resource affected by this error"
-    )
-    field: str | None = Field(None, description="Specific field within the resource")
 
+class EnvelopeE(BaseModel, Generic[ErrorT]):
+    """Complementary to models_library.generics.Envelope just for the generators"""
 
-class Error(BaseModel):
-    logs: list[Log] | None = Field(None, description="log messages")
-    errors: list[ErrorItem] | None = Field(None, description="errors metadata")
-    status: int | None = Field(None, description="HTTP error code")
+    error: ErrorT | None = None
+    data: Any | None = None
 
 
 class ParamSpec(NamedTuple):

api/specs/web-server/_folders.py

@@ -9,15 +9,17 @@
 
 from typing import Annotated
 
-from _common import as_query
+from _common import EnvelopeE, as_query
 from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.folders_v2 import (
     FolderCreateBodyParams,
     FolderGet,
     FolderReplaceBodyParams,
 )
 from models_library.generics import Envelope
+from models_library.rest_error import ErrorGet
 from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.folders._exceptions_handlers import _TO_HTTP_ERROR_MAP
 from simcore_service_webserver.folders._models import (
     FolderSearchQueryParams,
     FoldersListQueryParams,
@@ -29,6 +31,10 @@
     tags=[
         "folders",
     ],
+    responses={
+        i.status_code: {"model": EnvelopeE[ErrorGet]}
+        for i in _TO_HTTP_ERROR_MAP.values()
+    },
 )
 
 

api/specs/web-server/_workspaces.py

@@ -9,15 +9,17 @@
 from enum import Enum
 from typing import Annotated
 
-from _common import as_query
+from _common import EnvelopeE, as_query
 from fastapi import APIRouter, Depends, status
 from models_library.api_schemas_webserver.workspaces import (
     WorkspaceCreateBodyParams,
     WorkspaceGet,
     WorkspaceReplaceBodyParams,
 )
 from models_library.generics import Envelope
+from models_library.rest_error import ErrorGet
 from simcore_service_webserver._meta import API_VTAG
+from simcore_service_webserver.folders._exceptions_handlers import _TO_HTTP_ERROR_MAP
 from simcore_service_webserver.workspaces._groups_api import WorkspaceGroupGet
 from simcore_service_webserver.workspaces._models import (
     WorkspacesGroupsBodyParams,
@@ -31,6 +33,10 @@
     tags=[
         "workspaces",
     ],
+    responses={
+        i.status_code: {"model": EnvelopeE[ErrorGet]}
+        for i in _TO_HTTP_ERROR_MAP.values()
+    },
 )
 
 

services/web/server/src/simcore_service_webserver/login/utils.py

@@ -4,10 +4,10 @@
 from aiohttp import web
 from common_library.json_serialization import json_dumps
 from models_library.products import ProductName
+from models_library.rest_error import LogMessageType
 from models_library.users import UserID
 from pydantic import PositiveInt
 from servicelib.aiohttp import observer
-from servicelib.aiohttp.rest_models import LogMessageType
 from servicelib.aiohttp.status import HTTP_200_OK
 from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from simcore_postgres_database.models.users import UserRole