errorresponse | Schema-register

Foutmeldinggegevens

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
detail	`string`	Nee	Het detail van de foutmelding
instance	`string`	Nee	Het UUID waarmee een beheerder de foutmelding eenvoudig terug kan vinden in de log
parameterDetail	`array`	Nee	Een lijst met foutdetails over de gebruikte parameters Items type: $ref Items $ref: ./errorresponseparameter
status	`integer`	Nee	De HTTP status code Format: int32
title	`string`	Nee	De titel van het fouttype
type	`string`	Nee	De link naar het fouttype

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/logius/cor-api-services-xuflbx6ng/errorresponse",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Foutmeldinggegevens",
  "properties": {
    "detail": {
      "description": "Het detail van de foutmelding",
      "type": "string"
    },
    "instance": {
      "description": "Het UUID waarmee een beheerder de foutmelding eenvoudig terug kan vinden in de log",
      "type": "string"
    },
    "parameterDetail": {
      "description": "Een lijst met foutdetails over de gebruikte parameters",
      "items": {
        "$ref": "./errorresponseparameter"
      },
      "type": "array"
    },
    "status": {
      "description": "De HTTP status code",
      "format": "int32",
      "type": "integer"
    },
    "title": {
      "description": "De titel van het fouttype",
      "type": "string"
    },
    "type": {
      "description": "De link naar het fouttype",
      "type": "string"
    }
  },
  "type": "object",
  "x-derived-from": [
    "https://oinregister.logius.nl/api/v1/openapi.json#/components/schemas/ErrorResponse"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
errorresponseparameter	`/properties/parameterDetail/items/$ref`

Dit schema wordt niet door andere schema's gebruikt.

Health issues

Health issues
Message	Pointer
Set a concise non-empty title at the top level of the schema to explain what the definition is about
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/status/format`
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`

Schema-register: errorresponse

Details van JSON Schema: errorresponse

Details van JSON Schema: errorresponse

Beschrijving