Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion plane/api/v2/_kernel/errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 22 additions & 0 deletions tests/v2/test_errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Loading