queryable | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
description	`string, null`	Nee	a description of the property
id	`string, null`	Ja	the property name for use in expressions
mediaTypes	`array, null`	Nee	In cases where a property is available only in a subset of the supported feature encodings, the list of the media types of the encodings can be specified. This capabilitiy is also needed for cases where the names of properties may differ between feature encodings. For example, identifiers in an XML/GML encoding may include a namespace, in GeoJSON or MVT this is not the case. There are other reasons, too. For example, the property identifier in a Shapefile may be different because of length restrictions. Items type: string
required	`boolean, null`	Nee	indicator whether the property is always present in features Default: false
title	`string, null`	Nee	the title of the property for presentation to a human user
type	`string, null`	Ja	the data type of the property Enum: string, uri, enum, number, integer, date, dateTime, boolean

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/pdok/_shared/queryable",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "discriminator": {
    "mapping": {
      "boolean": "queryable-boolean",
      "date": "queryable-date",
      "dateTime": "queryable-dateTime",
      "enum": "queryable-enum",
      "integer": "queryable-number",
      "number": "queryable-number",
      "string": "queryable-string",
      "uri": "queryable-string"
    },
    "propertyName": "type"
  },
  "properties": {
    "description": {
      "description": "a description of the property",
      "type": [
        "string",
        "null"
      ]
    },
    "id": {
      "description": "the property name for use in expressions",
      "type": [
        "string",
        "null"
      ]
    },
    "mediaTypes": {
      "description": "In cases where a property is available only in a subset of the\nsupported feature encodings, the list of the media types of the\nencodings can be specified.\n\nThis capabilitiy is also needed for cases where the names of\nproperties may differ between feature encodings. For example, \nidentifiers in an XML/GML encoding may include a namespace, \nin GeoJSON or MVT this is not the case. \n\nThere are other reasons, too. For example, the property identifier\nin a Shapefile may be different because of length restrictions.",
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "required": {
      "default": false,
      "description": "indicator whether the property is always present in features",
      "type": [
        "boolean",
        "null"
      ]
    },
    "title": {
      "description": "the title of the property for presentation to a human user",
      "type": [
        "string",
        "null"
      ]
    },
    "type": {
      "description": "the data type of the property",
      "enum": [
        "string",
        "uri",
        "enum",
        "number",
        "integer",
        "date",
        "dateTime",
        "boolean"
      ],
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "type"
  ],
  "type": [
    "object",
    "null"
  ],
  "x-derived-from": [
    "https://api.pdok.nl/brt/top10nl/ogc/v1/openapi.json#/components/schemas/queryable",
    "https://api.pdok.nl/kadaster/bestuurlijkegebieden/ogc/v1/openapi.json#/components/schemas/queryable",
    "https://api.pdok.nl/kadaster/brk-kadastrale-kaart/ogc/v1/openapi.json#/components/schemas/queryable",
    "https://api.pdok.nl/kadaster/brt-achtergrondkaart/ogc/v1/openapi.json#/components/schemas/queryable",
    "https://api.pdok.nl/lv/bag/ogc/v1-demo/openapi.json#/components/schemas/queryable",
    "https://api.pdok.nl/lv/bag/ogc/v1/openapi.json#/components/schemas/queryable",
    "https://api.pdok.nl/lv/bgt/ogc/v1/openapi.json#/components/schemas/queryable"
  ]
}

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	`/discriminator`
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
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/mediaTypes/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/type/enum – /properties/type/type`

Schema-register: queryable

Details van JSON Schema: queryable

Details van JSON Schema: queryable

Beschrijving