ProblemDetails | Schema-register

Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
detail	`string`	Nee	Een gedetailleerde beschrijving van de HTTP status code.
instance	`string`	Nee	URI van de aanroep die fout heeft veroorzaakt. Format: uri
status	`integer`	Nee	De HTTP status code.
title	`string`	Nee	De titel behorende bij de HTTP status code.
type	`string`	Nee	URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar. Format: uri

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-voor-het-kadaster-en-de-openbare-registers/imbag-api-van-de-lvbag-7fnzbuehg/problemdetails",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Dit type bevat een definitief van het basis JSON object voor problem details conform RFC 7807.",
  "properties": {
    "detail": {
      "description": "Een gedetailleerde beschrijving van de HTTP status code.",
      "examples": [
        "Het verzoek vereist gebruikers authenticatie."
      ],
      "type": "string"
    },
    "instance": {
      "description": "URI van de aanroep die fout heeft veroorzaakt.",
      "format": "uri",
      "type": "string"
    },
    "status": {
      "description": "De HTTP status code.",
      "examples": [
        401
      ],
      "type": "integer"
    },
    "title": {
      "description": "De titel behorende bij de HTTP status code.",
      "examples": [
        "Niet correct geauthenticeerd"
      ],
      "type": "string"
    },
    "type": {
      "description": "URI naar een pagina met meer informatie over deze foutmelding voor de ontwikkelaar.\n",
      "examples": [
        "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#/10.4.2 401 Unauthorized"
      ],
      "format": "uri",
      "type": "string"
    }
  },
  "title": "ProblemDetails",
  "type": "object",
  "x-derived-from": [
    "https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml#/components/schemas/ProblemDetails"
  ]
}

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
extendedproblemdetails	`/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	`/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`
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`
Descriptions should not contain leading or trailing whitespace	`/properties/type/description`

Schema-register: ProblemDetails

Details van JSON Schema: ProblemDetails

Details van JSON Schema: ProblemDetails

Beschrijving