Problem Details

Problem Details (RFC 9457) representing an error response

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
detail	`string`	Ja	A human-readable explanation specific to this occurrence of the problem.
status	`integer`	Ja	The HTTP status code generated by the origin server for this occurrence of the problem. Minimum: 100 Maximum: 599
title	`string`	Ja	A short, human-readable summary of the problem type.

JSON Schema

{
  "$id": "https://schemas.developer.overheid.nl/schemas/adr/2.2/problemdetails",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Problem Details (RFC 9457) representing an error response",
  "properties": {
    "detail": {
      "description": "A human-readable explanation specific to this occurrence of the problem.",
      "examples": [
        "No building found with id 12345.",
        "ID should be an integer"
      ],
      "type": "string"
    },
    "status": {
      "description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
      "examples": [
        404,
        400
      ],
      "maximum": 599,
      "minimum": 100,
      "type": "integer"
    },
    "title": {
      "description": "A short, human-readable summary of the problem type.",
      "examples": [
        "Resource Not Found",
        "Bad Request"
      ],
      "type": "string"
    }
  },
  "required": [
    "status",
    "title",
    "detail"
  ],
  "title": "Problem Details",
  "type": "object"
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt gebruikt door
Schema	Locatie
Problem Details for Bad Request	`/allOf/0/$ref`

Health issues

Health issues
Message	Pointer
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/detail/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/status/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/title/description`

Schema-register: Problem Details

Details van JSON Schema: Problem Details

Details van JSON Schema: Problem Details

Beschrijving