A base OpenAPI for Problem Details for HTTP APIs, as defined by RFC 9457 — a way to carry machine-readable details of errors in an HTTP response, so nobody has to define a new error response format per API. RFC 9457 obsoleted RFC 7807 in July 2023, and the `urn:ietf:rfc:7807` XML namespace in the base is retained deliberately, per RFC 9457 Appendix B. Originally developed by Bump.sh as part of their [Train Travel API template](https://bump.sh/bump-examples/doc/train-travel-api), reduced here to a base just for showcasing Problem Details. Conformance is checked by the API Commons Problem Details Spectral ruleset, listed below.

Tags

• Problems
• Errors
• IETF
• RFC 9457

OpenAPI

The OpenAPI base for Problem Details for HTTP APIs.

Resources

• Repository — GitHubRepository
  The repository for the base.
• Spectral Ruleset — GitHubRepository
  Sixteen grounded rules checking an OpenAPI's error responses against RFC 9457 — the media type, the five members and their JSON types, extension members, and the headers that belong with 401 and 429. Adopt it by `extends` or from npm.
• Spectral Ruleset — Rules
• Spectral Ruleset — Specification

Return to All Base Schema Page