ProblemDetails

(No description in spec.)

Spec gap. ProblemDetails has no top-level description in the spec. The shape follows RFC 9457; the field meanings below are reproduced from the spec where present.

Gap ID f6f27f4f3347

Fields

Field Type Required Description
status integer yes The HTTP status code
title string yes Short human-readable summary of the problem type
traceId string yes Trace ID for tracking the request
detail string no Human-readable explanation specific to this occurrence of the problem
errors array of object no Optional list of errors encountered during the request

Each item in errors may include:

Field Type Description
parameter string The name of the query parameter that caused the error
field string The name of the field that caused the error
detail string Human-readable explanation of the error specific to this parameter or field
instance string no
type string no

Spec gap. type is a free-form URI reference with no enum. The set of values a client should expect is not enumerated in the spec, so do not branch on type for control flow — use status and title instead until the catalogue is published.

Gap ID 98c26218a99f

Example

{
  "title": "Resource Not Found",
  "status": 404,
  "traceId": "6d4a3a62-0d4b-4b96-9171-8c5070e01c35"
}