kanalen | Schema-register

Een lijst van kanalen en filters waarop het ABONNEMENT wordt afgenomen.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
filters	`object`	Nee	Map van kenmerken (sleutel/waarde) waarop notificaties gefilterd worden. Alleen notificaties waarvan de kenmerken voldoen aan het filter worden doorgestuurd naar de afnemer van het ABONNEMENT.
naam	`string`	Ja	De naam van het KANAAL (`KANAAL.naam`) waarop een abonnement is of wordt genomen. Min length: 1

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/vng/notificaties-api-ni-yju6hg/filtergroup",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Een lijst van kanalen en filters waarop het ABONNEMENT wordt afgenomen.",
  "properties": {
    "filters": {
      "additionalProperties": {
        "description": "Een waarde behorende bij de sleutel.",
        "maxLength": 1000,
        "minLength": 1,
        "title": "kenmerk",
        "type": "string"
      },
      "description": "Map van kenmerken (sleutel/waarde) waarop notificaties gefilterd worden. Alleen notificaties waarvan de kenmerken voldoen aan het filter worden doorgestuurd naar de afnemer van het ABONNEMENT.",
      "title": "Filters",
      "type": "object"
    },
    "naam": {
      "description": "De naam van het KANAAL (`KANAAL.naam`) waarop een abonnement is of wordt genomen.",
      "minLength": 1,
      "title": "Naam",
      "type": "string"
    }
  },
  "required": [
    "naam"
  ],
  "title": "kanalen",
  "type": "object",
  "x-derived-from": [
    "https://notificaties-api.vng.cloud/api/v1/schema/openapi.json#/components/schemas/FilterGroup"
  ]
}

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
abonnement	`/properties/kanalen/items/$ref`

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`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/filters/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/filters/additionalProperties/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/naam/description`

Schema-register: kanalen

Details van JSON Schema: kanalen

Details van JSON Schema: kanalen

Beschrijving