match | Schema-register

Verklaring van de gevonden match. In welk veld is de match gevonden, en welke karakters in het veld betreft het.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
end	`integer`	Ja	- Format: int32
matchedElement	`string`	Ja	- Enum: IDENTIFICATIE, OPGESTELD_DOOR, TITEL, TYPE
start	`integer`	Ja	- Format: int32
type	`string`	Ja	Geeft het type overeenkomst aan tussen de zoekopdracht en het gevonden resultaat. Enum: EXACT, FUZZY
zoekterm	`string`	Ja	-

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/omgevingsinformatie-ontsluiten-api-ow7p61mdg/match",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Verklaring van de gevonden match. In welk veld is de match gevonden, en welke karakters in het veld betreft het.",
  "properties": {
    "end": {
      "examples": [
        20
      ],
      "format": "int32",
      "type": "integer"
    },
    "matchedElement": {
      "enum": [
        "IDENTIFICATIE",
        "OPGESTELD_DOOR",
        "TITEL",
        "TYPE"
      ],
      "examples": [
        "TITEL"
      ],
      "type": "string"
    },
    "start": {
      "examples": [
        15
      ],
      "format": "int32",
      "type": "integer"
    },
    "type": {
      "description": "Geeft het type overeenkomst aan tussen de zoekopdracht en het gevonden resultaat.",
      "enum": [
        "EXACT",
        "FUZZY"
      ],
      "type": "string"
    },
    "zoekterm": {
      "examples": [
        "fiets"
      ],
      "type": "string"
    }
  },
  "required": [
    "end",
    "matchedElement",
    "start",
    "type",
    "zoekterm"
  ],
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/omgevingsinformatie/api/ontsluiten/v2/openapi.json#/components/schemas/Match"
  ]
}

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
documentsuggestie	`/properties/matches/items/$ref`

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
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/end/format`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/end/format`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/matchedElement/enum – /properties/matchedElement/type`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/start/format`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/start/format`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/type/enum – /properties/type/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/type/description`

Schema-register: match

Details van JSON Schema: match

Details van JSON Schema: match

Beschrijving