From cc557a83524a0710cee340af90a5cadd8d28e948 Mon Sep 17 00:00:00 2001 From: akhil-vamshi-konam Date: Tue, 17 Nov 2026 22:56:16 +0530 Subject: [PATCH] fix: name the field errors in a v2 error's message --- plane/api/v2/_kernel/errors.py | 5 ++++- tests/v2/test_errors.py | 22 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/plane/api/v2/_kernel/errors.py b/plane/api/v2/_kernel/errors.py index d58da2b..a304eef 100644 --- a/plane/api/v2/_kernel/errors.py +++ b/plane/api/v2/_kernel/errors.py @@ -32,7 +32,10 @@ def __init__( errors: list[FieldError] | None = None, response: Any = None, ) -> None: - super().__init__(f"HTTP {status} {code}: {detail}", status_code=status) + # The field messages say why; `detail` is often a generic "fields failed validation". + reasons = "; ".join(f"{error.field}: {error.message}" for error in errors or []) + message = f"HTTP {status} {code}: {detail}" + (f" ({reasons})" if reasons else "") + super().__init__(message, status_code=status) self.status = status self.type = type self.code = code diff --git a/tests/v2/test_errors.py b/tests/v2/test_errors.py index 82c2d6e..dcf581e 100644 --- a/tests/v2/test_errors.py +++ b/tests/v2/test_errors.py @@ -41,3 +41,25 @@ def test_from_payload_non_dict_body_still_carries_status() -> None: assert error.status == 502 assert error.code == "server_error" + + +def test_the_message_carries_the_field_messages() -> None: + err = PlaneAPIError.from_payload( + 400, + { + "code": "invalid_request", + "detail": "One or more fields failed validation.", + "errors": [{"field": "role", "code": "invalid", "message": "Guests stay guests."}], + }, + ) + + assert str(err) == ( + "HTTP 400 invalid_request: One or more fields failed validation. " + "(role: Guests stay guests.)" + ) + + +def test_the_message_without_field_errors_is_unchanged() -> None: + err = PlaneAPIError.from_payload(404, {"code": "not_found", "detail": "Not found."}) + + assert str(err) == "HTTP 404 not_found: Not found."