enumeration | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
enum	`array`	Ja	- Items type: string
type	`string`	Ja	- Enum: enum

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/pdok/_shared/enumeration",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "enum": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "enum": [
        "enum"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "enum"
  ],
  "type": "object",
  "x-derived-from": [
    "https://api.pdok.nl/brt/top10nl/ogc/v1/openapi.json#/components/schemas/enumeration",
    "https://api.pdok.nl/kadaster/bestuurlijkegebieden/ogc/v1/openapi.json#/components/schemas/enumeration",
    "https://api.pdok.nl/kadaster/brk-kadastrale-kaart/ogc/v1/openapi.json#/components/schemas/enumeration",
    "https://api.pdok.nl/kadaster/brt-achtergrondkaart/ogc/v1/openapi.json#/components/schemas/enumeration",
    "https://api.pdok.nl/lv/bag/ogc/v1-demo/openapi.json#/components/schemas/enumeration",
    "https://api.pdok.nl/lv/bag/ogc/v1/openapi.json#/components/schemas/enumeration",
    "https://api.pdok.nl/lv/bgt/ogc/v1/openapi.json#/components/schemas/enumeration",
    "https://api.pdok.nl/omgevingswet/omgevingsdocumenten/ogc/v2/openapi.json#/components/schemas/enumeration"
  ]
}

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
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/type/enum – /properties/type/type`
An `enum` of a single value can be expressed as `const`	`/properties/type/enum`

Schema-register: enumeration

Details van JSON Schema: enumeration

Details van JSON Schema: enumeration

Beschrijving