API-info | Schema-register

Algemene informatie voor gebruikers van de API.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
api-description	`string`	Nee	Omschrijving van de API.
api-name	`string`	Nee	De naam van de API.
api-version	`string`	Nee	Versie van de API.
informationmodel	`string`	Nee	Naam van het informatiemodel dat als basis is genomen voor deze API.
informationmodel-location	`string`	Nee	Locatie (URI) van het logische informatiemodel die als basis is genomen voor deze API. Format: URI
informationmodel-version	`string`	Nee	Versie van het logische informatiemodel dat als basis is genomen voor deze API.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/dienst-voor-het-kadaster-en-de-openbare-registers/imbag-api-van-de-lvbag-7fnzbuehg/apiinfo",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Algemene informatie voor gebruikers van de API.",
  "properties": {
    "api-description": {
      "description": "Omschrijving van de API.",
      "type": "string"
    },
    "api-name": {
      "description": "De naam van de API.",
      "type": "string"
    },
    "api-version": {
      "description": "Versie van de API.",
      "type": "string"
    },
    "informationmodel": {
      "description": "Naam van het informatiemodel dat als basis is genomen voor deze API.",
      "examples": [
        "IMBAGLV"
      ],
      "type": "string"
    },
    "informationmodel-location": {
      "description": "Locatie (URI) van het logische informatiemodel die als basis is genomen voor deze API.",
      "format": "URI",
      "type": "string"
    },
    "informationmodel-version": {
      "description": "Versie van het logische informatiemodel dat als basis is genomen voor deze API.",
      "examples": [
        "v20190601"
      ],
      "type": "string"
    }
  },
  "title": "API-info",
  "type": "object",
  "x-derived-from": [
    "https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2/openapi.yaml#/components/schemas/API-info"
  ]
}

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 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`
Set `properties` to identifier names that can be easily mapped to programming languages (matching [A-Za-z_][A-Za-z0-9_]*)	`/properties/api-description – /properties/api-name – /properties/api-version – /properties/informationmodel-location – /properties/informationmodel-version`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/api-description/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/api-name/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/api-version/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/informationmodel/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/informationmodel-location/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/informationmodel-location/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/informationmodel-version/description`

Schema-register: API-info

Details van JSON Schema: API-info

Details van JSON Schema: API-info

Beschrijving