metadata | Schema-register

metadata

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
bestandsnaam	`string`	Ja	-
documentOmschrijving	`string`	Ja	aanduiding van de aard van de gevraagde bijlage zoals gehanteerd door de zaakbehandelende organisatie, gebaseerd op 'documenttypeGeneriek'. Bevat een lege string als de documentOmschrijving niet bekend is.
formaat	`string`	Ja	het MIME-type
vertrouwelijkAanduiding	`string`	Ja	geeft aan of het document als vertrouwelijk moet worden behandeld. Enum: Vertrouwelijk, Niet vertrouwelijk

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/_shared/metadata",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "metadata",
  "properties": {
    "bestandsnaam": {
      "type": "string"
    },
    "documentOmschrijving": {
      "description": "aanduiding van de aard van de gevraagde bijlage zoals gehanteerd door de zaakbehandelende organisatie, gebaseerd op 'documenttypeGeneriek'. Bevat een lege string als de documentOmschrijving niet bekend is.",
      "type": "string"
    },
    "formaat": {
      "description": "het MIME-type",
      "type": "string"
    },
    "vertrouwelijkAanduiding": {
      "description": "geeft aan of het document als vertrouwelijk moet worden behandeld.",
      "enum": [
        "Vertrouwelijk",
        "Niet vertrouwelijk"
      ],
      "type": "string"
    }
  },
  "required": [
    "bestandsnaam",
    "vertrouwelijkAanduiding",
    "documentOmschrijving",
    "formaat"
  ],
  "type": "object",
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/196036/verzoeken-afhandelen-v2.json",
    "https://developer.omgevingswet.overheid.nl/publish/pages/196036/verzoeken-afhandelen-v3.json"
  ]
}

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

Schema-register: metadata

Details van JSON Schema: metadata

Details van JSON Schema: metadata

Beschrijving