error enveloped

Author: pcrespov

api/specs/web-server/_auth.py

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

api/specs/web-server/_folders.py

@@ -9,15 +9,15 @@
 
 from typing import Annotated
 
-from _common import EnvelopeE, as_query
+from _comon import 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 models_library.rest_error import EnvelopedError
 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 (
@@ -32,8 +32,7 @@
         "folders",
     ],
     responses={
-        i.status_code: {"model": EnvelopeE[ErrorGet]}
-        for i in _TO_HTTP_ERROR_MAP.values()
+        i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
     },
 )
 

api/specs/web-server/_workspaces.py

@@ -9,15 +9,15 @@
 from enum import Enum
 from typing import Annotated
 
-from _common import EnvelopeE, as_query
+from _common import 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 models_library.rest_error import EnvelopedError
 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
@@ -34,8 +34,7 @@
         "workspaces",
     ],
     responses={
-        i.status_code: {"model": EnvelopeE[ErrorGet]}
-        for i in _TO_HTTP_ERROR_MAP.values()
+        i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
     },
 )
 

packages/models-library/src/models_library/rest_error.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass
-from typing import Annotated
+from typing import Annotated, Any
 
+from models_library.generics import Envelope
 from pydantic import BaseModel, ConfigDict, Field
 
 from .basic_types import IDStr, LogLevel
@@ -75,8 +76,7 @@ class ErrorGet(BaseModel):
         Field(description="ID to track the incident during support", alias="supportId"),
     ] = None
 
-    # NOTE: The fields blow are DEPRECATED.
-    # Still here to keep compatibilty with front-end until updated
+    # NOTE: The fields blow are DEPRECATED. Still here to keep compatibilty with front-end until updated
     status: Annotated[int, Field(deprecated=True)] = 400
     errors: Annotated[
         list[ErrorItemType],
@@ -93,11 +93,29 @@ class ErrorGet(BaseModel):
         frozen=True,
         json_schema_extra={
             "examples": [
-                {"msg": "Sorry you do not have sufficient access rights for product"},
                 {
-                    "msg": "Opps this error was unexpected. We are working on that!",
+                    "message": "Sorry you do not have sufficient access rights for product"
+                },
+                {
+                    "message": "Opps this error was unexpected. We are working on that!",
                     "supportId": "OEC:12346789",
                 },
             ]
         },
     )
+
+
+class EnvelopedError(Envelope[Any]):
+    error: ErrorGet  # type: ignore
+
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {"error": {"message": "display error message here"}},
+                {
+                    "error": {"message": "failure", "supportId": "OEC:123455"},
+                    "data": None,
+                },
+            ]
+        },
+    )