Problem Details for Bad Request

Problem Details (RFC 9457) for a 400 Bad Request, extended with the validation errors that caused it

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
errors	`array`	Nee	List of errors encountered during processing Items type: object
errors[].code	`string`	Ja	A code representing the type of error
errors[].detail	`string`	Ja	A detailed message describing the error
errors[].in	`string`	Ja	Location of the error (e.g., body, query, header) Enum: body, path, query, header
errors[].location	`string`	Ja	Where the error occurred: a JSON Pointer (RFC 6901) into the request body when `in` is `body`, otherwise the name of the path, query or header parameter

JSON Schema

{
  "$id": "https://schemas.developer.overheid.nl/schemas/don/problemdetailsbadrequest",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "allOf": [
    {
      "$ref": "../adr/2.2/problemdetails"
    }
  ],
  "description": "Problem Details (RFC 9457) for a 400 Bad Request, extended with the validation errors that caused it",
  "properties": {
    "errors": {
      "description": "List of errors encountered during processing",
      "items": {
        "properties": {
          "code": {
            "description": "A code representing the type of error",
            "examples": [
              "date.format",
              "string.minLength"
            ],
            "type": "string"
          },
          "detail": {
            "description": "A detailed message describing the error",
            "examples": [
              "must be ISO 8601",
              "must be at least 3 characters"
            ],
            "type": "string"
          },
          "in": {
            "description": "Location of the error (e.g., body, query, header)",
            "enum": [
              "body",
              "path",
              "query",
              "header"
            ],
            "examples": [
              "body",
              "query"
            ],
            "type": "string"
          },
          "location": {
            "description": "Where the error occurred: a JSON Pointer (RFC 6901) into the request body when `in` is `body`, otherwise the name of the path, query or header parameter",
            "examples": [
              "/foo/0/bar",
              "page"
            ],
            "type": "string"
          }
        },
        "required": [
          "in",
          "location",
          "code",
          "detail"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "title": "Problem Details for Bad Request",
  "type": "object"
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
Problem Details	`/allOf/0/$ref`

Dit schema wordt niet door andere schema's gebruikt.

Health issues

Health issues
Message	Pointer
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Wrapping `$ref` in `allOf` was only necessary in JSON Schema Draft 7 and older	`/allOf/0/$ref`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/errors/items/properties/in/enum – /properties/errors/items/properties/in/type`

Schema-register: Problem Details for Bad Request

Details van JSON Schema: Problem Details for Bad Request

Details van JSON Schema: Problem Details for Bad Request

Beschrijving