healthcheckresponse | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
checks	`array, null`	Nee	- Items type: $ref Items $ref: ./healthchecklistitem
status	`string`	Nee	- Enum: UP, DOWN

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/logius/cor-api-services-xuflbx6ng/healthcheckresponse",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "checks": {
      "items": {
        "$ref": "./healthchecklistitem"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "status": {
      "enum": [
        "UP",
        "DOWN"
      ],
      "type": "string"
    }
  },
  "type": "object",
  "x-derived-from": [
    "https://oinregister.logius.nl/api/v1/openapi.json#/components/schemas/HealthCheckResponse"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
healthchecklistitem	`/properties/checks/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 description at the top level of the schema to explain what the definition is about in detail
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/status/enum – /properties/status/type`

Schema-register: healthcheckresponse

Details van JSON Schema: healthcheckresponse

Details van JSON Schema: healthcheckresponse

Beschrijving