Skip to content

docs: Document error response format (RFC 7807) in README#55

Merged
thced merged 1 commit into
masterfrom
docs/readme-error-format
May 13, 2026
Merged

docs: Document error response format (RFC 7807) in README#55
thced merged 1 commit into
masterfrom
docs/readme-error-format

Conversation

@thced

@thced thced commented May 13, 2026

Copy link
Copy Markdown
Contributor

Add an "Error responses" subsection covering:

  • The application/problem+json body shape (type, title, status, detail, pointer, keyword) emitted by ProblemDetailRenderer.
  • Single-error reporting (first failure wins).
  • JSON-Pointer pointer field per RFC 6901.
  • Common keyword values for validation failures.
  • An example body for a typical coercion failure.
  • 404 / 405 / 500 surfaces and how to override via ExceptionHandler.

Add an "Error responses" subsection covering:
- The application/problem+json body shape (type, title, status,
  detail, pointer, keyword) emitted by ProblemDetailRenderer.
- Single-error reporting (first failure wins).
- JSON-Pointer pointer field per RFC 6901.
- Common keyword values for validation failures.
- An example body for a typical coercion failure.
- 404 / 405 / 500 surfaces and how to override via ExceptionHandler.
@thced thced merged commit 942d625 into master May 13, 2026
3 checks passed
@thced thced deleted the docs/readme-error-format branch May 13, 2026 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant