Problem Details | Schema-register

Foutmelding conform RFC 7807.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
detail	`string`	Nee	Mens-leesbare uitleg van dit specifieke probleem.
instance	`string`	Nee	Absolute URI dat dit specifieke probleem identificeert. Format: uri
status	`integer`	Nee	De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet. Format: int32
title	`string`	Nee	Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.
type	`string`	Nee	Absolute URI dat het probleemtype identificeert. Format: uri

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/omgevingsinformatie-ontsluiten-api-ow7p61mdg/error",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Foutmelding conform RFC 7807.",
  "externalDocs": {
    "description": "RFC 7807 - Problem Details for HTTP APIs",
    "url": "https://datatracker.ietf.org/doc/html/rfc7807"
  },
  "properties": {
    "detail": {
      "description": "Mens-leesbare uitleg van dit specifieke probleem.",
      "examples": [
        "Identificatie 123 heeft geen resultaat opgeleverd."
      ],
      "type": "string"
    },
    "instance": {
      "description": "Absolute URI dat dit specifieke probleem identificeert.",
      "examples": [
        "urn:uuid:608aa448-1b28-11e8-accf-0ed5f89f718b"
      ],
      "format": "uri",
      "type": "string"
    },
    "status": {
      "description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.",
      "examples": [
        404
      ],
      "format": "int32",
      "type": "integer"
    },
    "title": {
      "description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars.",
      "examples": [
        "De aanvraag bestaat niet."
      ],
      "type": "string"
    },
    "type": {
      "description": "Absolute URI dat het probleemtype identificeert.",
      "examples": [
        "https://content.omgevingswet.overheid.nl/fout/id/concept/BestaatNiet"
      ],
      "format": "uri",
      "type": "string"
    }
  },
  "title": "Problem Details",
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/omgevingsinformatie/api/ontsluiten/v2/openapi.json#/components/schemas/Error"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt niet door andere schema's gebruikt.

Health issues

Health issues
Message	Pointer
Future versions of JSON Schema will refuse to evaluate unknown keywords or custom keywords from optional vocabularies that don't have an x- prefix	`/externalDocs`
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	`/description`
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/instance/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/status/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/status/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/status/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/title/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/type/description`

Schema-register: Problem Details

Details van JSON Schema: Problem Details

Details van JSON Schema: Problem Details

Beschrijving