API | Schema-register - developer.overheid.nl

An API

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
auth	`array`	Ja	The authentication methods supported by the API Items type: string
contact	`object`	Ja	Contact details
contact.email	`string`	Ja	The email address of the contact Format: email
contact.name	`string`	Ja	The name of the contact
contact.url	`string`	Ja	The URL of the contact Format: uri
description	`string`	Ja	The description of the API
docsUrl	`string`	Nee	The URL to the documentation of the API Format: uri
lifecycle	`$ref`	Ja	- $ref: apilifecycle
oasUrl	`string`	Nee	The URL of the OAS document Format: uri
organisation	`$ref`	Ja	- $ref: organisation
servers	`array`	Ja	- Items type: object
servers[].description	`string`	Ja	A description of the server
servers[].url	`string`	Ja	The URL of the server Format: uri
summary	`string`	Ja	Short plain-text summary of the API. Derived from description when no explicit summary is available.
title	`string`	Ja	The title of the API

JSON Schema

{
  "$id": "https://schemas.developer.overheid.nl/schemas/don/api",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "An API",
  "properties": {
    "auth": {
      "description": "The authentication methods supported by the API",
      "items": {
        "examples": [
          "OAuth2",
          "API Key"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "contact": {
      "description": "Contact details",
      "properties": {
        "email": {
          "description": "The email address of the contact",
          "examples": [
            "developer.overheid@geonovum.nl",
            "api@geonovum.nl"
          ],
          "format": "email",
          "type": "string"
        },
        "name": {
          "description": "The name of the contact",
          "examples": [
            "developer.overheid.nl",
            "Geonovum"
          ],
          "type": "string"
        },
        "url": {
          "description": "The URL of the contact",
          "examples": [
            "https://github.com/developer-overheid-nl",
            "https://github.com/geonovum"
          ],
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "email",
        "name",
        "url"
      ],
      "type": "object"
    },
    "description": {
      "description": "The description of the API",
      "examples": [
        "This is version 1 of the API register. This description can also contain Markdown.",
        "Register of open source repositories published by Dutch government organisations."
      ],
      "type": "string"
    },
    "docsUrl": {
      "description": "The URL to the documentation of the API",
      "examples": [
        "https://developer.overheid.nl/kennisbank/",
        "https://www.geonovum.nl/api"
      ],
      "format": "uri",
      "type": "string"
    },
    "lifecycle": {
      "$ref": "apilifecycle"
    },
    "oasUrl": {
      "description": "The URL of the OAS document",
      "examples": [
        "https://api.developer.overheid.nl/api-register/v1/openapi.json",
        "https://api.developer.overheid.nl/oss-register/v1/openapi.json"
      ],
      "format": "uri",
      "type": "string"
    },
    "organisation": {
      "$ref": "organisation"
    },
    "servers": {
      "items": {
        "properties": {
          "description": {
            "description": "A description of the server",
            "examples": [
              "Production server",
              "Test server"
            ],
            "type": "string"
          },
          "url": {
            "description": "The URL of the server",
            "examples": [
              "https://api.developer.overheid.nl/api-register/v1",
              "https://api.developer.overheid.nl/oss-register/v1"
            ],
            "format": "uri",
            "type": "string"
          }
        },
        "required": [
          "url",
          "description"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "summary": {
      "description": "Short plain-text summary of the API. Derived from description when no explicit summary is available.",
      "examples": [
        "Catalogue of the APIs of the Dutch government.",
        "Register of open source repositories of the Dutch government."
      ],
      "type": "string"
    },
    "title": {
      "description": "The title of the API",
      "examples": [
        "API register API v1",
        "OSS register API v1"
      ],
      "type": "string"
    }
  },
  "required": [
    "contact",
    "title",
    "summary",
    "description",
    "organisation",
    "lifecycle",
    "auth",
    "servers"
  ],
  "title": "API",
  "type": "object"
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
API Lifecycle	`/properties/lifecycle/$ref`
Organisation	`/properties/organisation/$ref`

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	`/properties/summary/description`

Schema-register: API

Details van JSON Schema: API

Details van JSON Schema: API

Beschrijving