Handbook
Scenario — HTTP error envelopes for builders
Your client parses { "ok": false, ... } consistently and matches CI fixtures.
Updated
Outcome
Your client parses { "ok": false, ... } consistently and matches CI fixtures.
Canonical path
Schemas and API for builders — safe GET examples only in tutorials; error shape is for documentation and tests.
Fixtures
sample-api-error.json — api-error.schema.json; run pytest tests/test_docs_schemas.py.
Avoid
- Logging full error bodies that contain PII or tokens — scrub in operational pipelines.