VNG Realisatie Events API

openapi: 3.2.0
info:
  title: Vng Realisatie Events API
  version: 2.0.0-alpha13
  license:
    name: EUPL 1.2
    url: https://opensource.org/licenses/EUPL-1.2
  description: 'Operations tagged events across 2 of this provider''s published API definitions: vng-realisatie-notificaties-openapi.yml, vng-realisatie-notificaties-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/v1
security:
- JWT-Claims: []
tags:
- name: Events
  description: ''
paths:
  /events:
    parameters: []
    post:
      operationId: events_create
      summary: Publish an event
      description: 'The component will distribute the event to the subscribers when the criteria

        of a subscription are met.'
      parameters:
      - name: Content-Type
        in: header
        description: Content type van de verzoekinhoud.
        required: true
        schema:
          type: string
          enum:
          - application/json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Event'
        required: true
      responses:
        '200':
          description: ''
          headers:
            API-version:
              schema:
                type: string
              description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
      tags:
      - Events
      security:
      - JWT-Claims:
        - events.publish
    servers:
    - url: /api/v1
components:
  schemas:
    Event:
      required:
      - id
      - specversion
      - source
      - domain
      - type
      type: object
      properties:
        id:
          title: Id
          description: Identifies the event. Producers MUST ensure that source + id is unique for each distinct event. SHOULD be a UUID.
          type: string
          minLength: 1
        specversion:
          title: Specversion
          description: The version of the CloudEvents specification which the event uses. Compliant event producers MUST use a value of 1.0 when referring to this version of the specification.
          type: string
          enum:
          - '1.0'
        source:
          title: Source
          description: Identifies the context in which an event happened. SHOULD be a URN notation with 'nld' as namespace identifier. SHOULD contain consecutive a unique identifier of the organization that publishes the event followed by the source system that publishes the event. Involved organizations SHOULD agree on how organizations and systems are uniquely identified (e.g. via the use of OIN, KVK-nummer or eIDAS legal identifier for organization identification);.
          type: string
          minLength: 1
        domain:
          title: Domain
          description: Name of the domain to which the event belongs. Can be seen as the namespace of the event.(This attribute is not listed in the GOV NL profile for CloudEvents).
          type: string
        type:
          title: Type
          description: Beschrijft het type EVENT afkomstig van het specifieke DOMAIN.This attribute contains a value describing the type of event. Type SHOULD start with the domain followed by the name of the event. Events SHOULD be expressed in the past tense. If subtypes are required those SHOULD be expressed using a dot '.' between the super and subtype(s). The type MAY contain version information. Version information SHOULD be appended at the end of the string.
          type: string
          minLength: 1
        time:
          title: Time
          description: Timestamp of the event. SHOULD be the timestamp the event was registered in the source system and NOT the time the event occurred in reality. The exact meaning of time MUST be clearly documented.
          type:
          - string
          - 'null'
          format: date-time
        subscription:
          title: Subscription
          description: Usually empty. Only used in situations where notificationservices are chained. For example notificationservice2 (ns2) is subscribed to notifcationservice1 (ns1). When ns1 sends an event to ns2 this attribute SHOULD contain the subscription id of the subscription that ns1 has on ns2 (that was resposible for receiving the event). Note this attribute is overwritten when the event is passed through to a client. It will be set to the value of the subscription id of the subscription of the client.
          type:
          - string
          - 'null'
          format: uuid
        subscriberReference:
          title: Subscriberreference
          description: Usually empty. Only used in situations where notificationservices are chained. For example notificationservice2 (ns2) is subscribed to notifcationservice1 (ns1). When ns1 sends an event to ns2 this attribute COULD contain the subscriberReference the was specified when ns2 subscribed to ns1. Note this attribute is overwritten when the event is passed through to a client. It will be set to the value of the subscriberReference of the subscription of the client (when specified by the client).
          type:
          - string
          - 'null'
          maxLength: 255
          minLength: 1
        datacontenttype:
          title: Datacontenttype
          description: Content type of data value. In this version of the API the value MUST be 'application/json'. In future versions of the API other values such as described in RFC 2046 MAY be used.
          type:
          - string
          - 'null'
          minLength: 1
        dataschema:
          title: Dataschema
          description: Identifies the schema that data adheres to.
          type:
          - string
          - 'null'
          format: uri
          minLength: 1
        sequence:
          title: Sequence
          description: Value expressing the relative order of the event. This enables interpretation of data supercedence.
          type:
          - string
          - 'null'
          minLength: 1
        sequencetype:
          title: Sequencetype
          description: Specifies the semantics of the sequence attribute. (Currently limited to the value INTEGER).
          type:
          - string
          - 'null'
          enum:
          - Integer
        subject:
          title: Subject
          description: Included to be compatible with CloudEvents specification. The GOV NL profile states 'Decision on whether or not to use the attribute and/or the exact interpretation is postponed. To be determined partly on the basis of future agreements about subscription and filtering.'
          type:
          - string
          - 'null'
          minLength: 1
        data:
          title: Data
          type:
          - object
          - 'null'
        data_base64:
          title: Data base64
          description: The presence of the data_base64 member clearly indicates that the value is a Base64 encoded binary data, which the serializer MUST decode into a binary runtime data type.
          type:
          - string
          - 'null'
          minLength: 1
        dataref:
          title: Dataref
          description: A reference to a location where the event payload is stored. If both the data attribute and the dataref attribute are specified their contents MUST be identical.
          type:
          - string
          - 'null'
          minLength: 1
  securitySchemes:
    JWT-Claims:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- vng-realisatie-notificaties-openapi.yml
- vng-realisatie-notificaties-openapi.yml