contentitemfull | Schema-register

A content item.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`$ref`	Ja	- $ref: ../../_shared/links
afbeelding	`object`	Ja	An image associated this item.
afbeelding.alt-text	`string, null`	Nee	Alternative text for the image, can be null.
afbeelding.url	`string`	Nee	The URL of the image. Format: uri
gepubliceerdOp	`string`	Ja	The published date and time of the content-item in ISO 8601 * format. Format: date-time
id	`string`	Ja	A unique identifier in UUID format from a sector, country, content-item etc. Format: uuid
landen	`array`	Ja	A list of countries associated with the content-item. Items type: $ref Items $ref: ./country
link	`string`	Ja	A URL to the * content-item's detail page. Format: uri
sectoren	`array`	Ja	A list of industry sectors associated with the * content-item. Items type: $ref Items $ref: ./sector
tekst	`string`	Ja	Raw * HTML content of the content-item description. Clients must ensure to * properly escape this content when rendering to prevent XSS * vulnerabilities. Format: html
titel	`string`	Ja	The title of the content-item.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/rijksdienst-voor-ondernemend-nederland/iio-api-aakgfxenr/contentitemfull",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "A content item.",
  "properties": {
    "_links": {
      "$ref": "../../_shared/links"
    },
    "afbeelding": {
      "description": "An image associated this item.",
      "examples": [
        {
          "alt-text": "Default image for the content-item",
          "url": "https://ih-static.rvo.nl/sites/default/files/fallback_images/2.svg"
        }
      ],
      "properties": {
        "alt-text": {
          "description": "Alternative text for the image, can be null.",
          "examples": [
            "A beautiful sunset over the mountains"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "url": {
          "description": "The URL of the image.",
          "examples": [
            "https://example.com/images/sunset.jpg"
          ],
          "format": "uri",
          "type": "string"
        }
      },
      "type": "object"
    },
    "gepubliceerdOp": {
      "description": "The published date and time of the content-item in ISO 8601\n   *   format.",
      "examples": [
        "2024-02-10T09:00:06+01:00"
      ],
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "description": "A unique identifier in UUID format from a sector, country, content-item etc.",
      "format": "uuid",
      "type": "string"
    },
    "landen": {
      "description": "A list of countries associated with the content-item.",
      "items": {
        "$ref": "./country"
      },
      "type": "array"
    },
    "link": {
      "description": "A URL to the\n   *   content-item's detail page.",
      "examples": [
        "https://example.com/content/123"
      ],
      "format": "uri",
      "type": "string"
    },
    "sectoren": {
      "description": "A list of industry sectors associated with the\n   *   content-item.",
      "items": {
        "$ref": "./sector"
      },
      "type": "array"
    },
    "tekst": {
      "description": "Raw\n   *   HTML content of the content-item description. Clients must ensure to\n   *   properly escape this content when rendering to prevent XSS\n   *   vulnerabilities.",
      "examples": [
        "<p>This is an example of HTML content.</p>"
      ],
      "format": "html",
      "type": "string"
    },
    "titel": {
      "description": "The title of the content-item.",
      "examples": [
        "Doing Business in\n   *   Germany"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "titel",
    "tekst",
    "link",
    "afbeelding",
    "gepubliceerdOp",
    "landen",
    "sectoren",
    "_links"
  ],
  "type": "object",
  "x-derived-from": [
    "https://internationaal.ondernemen.overheid.nl/api/iio/v1/openapi.yaml#/components/schemas/ContentItemFull"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
links	`/properties/_links/$ref`
country	`/properties/landen/items/$ref`
sector	`/properties/sectoren/items/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
contentitemcollection	`/properties/content-items/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`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/afbeelding/description`
Set `properties` to identifier names that can be easily mapped to programming languages (matching [A-Za-z_][A-Za-z0-9_]*)	`/properties/afbeelding/properties/alt-text`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/afbeelding/properties/alt-text/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/afbeelding/properties/url/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/gepubliceerdOp/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/id/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/landen/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/link/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/sectoren/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/tekst/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/tekst/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/titel/description`

Schema-register: contentitemfull

Details van JSON Schema: contentitemfull

Details van JSON Schema: contentitemfull

Beschrijving