sgerrand / ex_humaans / 25313910988

99%

push

github

feat(error): extract structured Humaans API error fields (#88)

* feat(error): extract structured Humaans API error fields

Humaans returns a structured error envelope on 4xx/5xx responses with
id, code, name, message, and an optional issues[] array of field-level
validation errors. Previously callers had to inspect the raw body via
Map.get/2.

Adds top-level fields code, name, api_message, and issues to
Humaans.Error and a from_api_response/2 builder. The raw body is
retained for forward-compat with undocumented fields. Existing pattern
matches on type/status/body/reason continue to work.

The new field is named api_message rather than message to avoid
shadowing the Exception.message/1 callback.

* fix(error): align typespecs with runtime behavior

Widen body to any() since from_api_response/2 accepts non-map bodies
(e.g. HTML/string responses from 5xx errors), and validate that issues
elements are maps before populating the field so the [issue()] typespec
holds.

* docs: clarify api_message field name in CLAUDE.md

The Humaans.Error struct exposes the API's message under the
api_message field (the rename avoids shadowing Exception.message/1).
Update the architecture notes so they match the struct rather than
implying a top-level message field exists.

9 of 9 new or added lines in 1 file covered. (100.0%)

150 of 150 relevant lines covered (100.0%)

19.52 hits per line