♻️ Currently frontend is expecting status field in error response b…

…ody (#7256)
ITISFoundation · Feb 21, 2025 · 870b9b2 · 870b9b2
1 parent b084481
commit 870b9b2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 8 deletions.
diff --git a/packages/models-library/src/models_library/rest_error.py b/packages/models-library/src/models_library/rest_error.py
@@ -75,9 +75,9 @@ class ErrorGet(BaseModel):
         IDStr | None,
         Field(description="ID to track the incident during support", alias="supportId"),
     ] = None
+    status: int
 
     # 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],
         Field(deprecated=True, default_factory=list, json_schema_extra={"default": []}),
@@ -94,11 +94,13 @@ class ErrorGet(BaseModel):
         json_schema_extra={
             "examples": [
                 {
-                    "message": "Sorry you do not have sufficient access rights for product"
+                    "message": "Sorry you do not have sufficient access rights for product",
+                    "status": 401,
                 },
                 {
                     "message": "Opps this error was unexpected. We are working on that!",
                     "supportId": "OEC:12346789",
+                    "status": 500,
                 },
             ]
         },
@@ -111,9 +113,13 @@ class EnvelopedError(Envelope[None]):
     model_config = ConfigDict(
         json_schema_extra={
             "examples": [
-                {"error": {"message": "display error message here"}},
+                {"error": {"message": "display error message here", "status": 401}},
                 {
-                    "error": {"message": "failure", "supportId": "OEC:123455"},
+                    "error": {
+                        "message": "failure",
+                        "supportId": "OEC:123455",
+                        "status": 500,
+                    },
                     "data": None,
                 },
             ]

diff --git a/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml b/services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml
@@ -10021,8 +10021,6 @@ components:
         status:
           type: integer
           title: Status
-          default: 400
-          deprecated: true
         errors:
           items:
             $ref: '#/components/schemas/ErrorItemType'
@@ -10040,6 +10038,7 @@ components:
       type: object
       required:
       - message
+      - status
       title: ErrorGet
     ErrorItemType:
       properties:

diff --git a/services/web/server/src/simcore_service_webserver/exception_handling/_factory.py b/services/web/server/src/simcore_service_webserver/exception_handling/_factory.py
@@ -80,7 +80,7 @@ async def _exception_handler(
             _DefaultDict(getattr(exception, "__dict__", {}))
         )
 
-        error = ErrorGet.model_construct(message=user_msg)
+        error = ErrorGet.model_construct(message=user_msg, status=status_code)
 
         if is_5xx_server_error(status_code):
             oec = create_error_code(exception)
@@ -100,7 +100,9 @@ async def _exception_handler(
                     },
                 )
             )
-            error = ErrorGet.model_construct(message=user_msg, support_id=oec)
+            error = ErrorGet.model_construct(
+                message=user_msg, support_id=oec, status=status_code
+            )
 
         return create_error_response(error, status_code=status_code)