eneveloped error

Author: pcrespov

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,12 @@ 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",
-            }
-        }
-    )
-
-
-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")
+ErrorT = TypeVar("ErrorT")
 
 
-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")
+class EnvelopeE(BaseModel, Generic[ErrorT]):
+    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()
+    },
 )
 
 

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

@@ -3,7 +3,40 @@
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from .basic_types import IDStr
+from .basic_types import IDStr, LogLevel
+
+
+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",
+            }
+        }
+    )
+
+
+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")
 
 
 @dataclass