@vng-api/openvtb-berichten 0.1.0

package/README.md

@@ -0,0 +1,11 @@
+# @vng-api/openvtb-berichten
+
+Gebundelde OpenAPI-specificatie voor **Berichten API** (versie 0.1.0), uit [VNG-Realisatie/Interactie-APIs](https://github.com/VNG-Realisatie/Interactie-APIs).
+
+```js
+const spec = require("@vng-api/openvtb-berichten"); // geparste openapi.json
+```
+
+Ook beschikbaar als YAML: `@vng-api/openvtb-berichten/openapi.yaml`.
+
+Bron: `apis/rest/openvtb-berichten/v0.1.0.yaml` — externe `$ref`s naar `schemas/` en `patterns/` zijn ge-inlined.

package/openapi.json

@@ -0,0 +1,421 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Berichten API",
+    "version": "0.1.0",
+    "description": "De berichten-service bestaat uit een beschrijving van afspraken, standaarden en referentiecomponenten aangevuld met interactiepatronen, ontwerpbesluiten en aanbevelingen. Het Berichten-patroon biedt een gestandaardiseerde, flexibele oplossing voor de communicatie tussen inwoners, ondernemers en gemeenten via digitale kanalen. Met dit patroon kunnen berichten eenvoudig geregistreerd worden en door verschillende applicaties worden opgehaald, weergegeven en verwerkt. In tegenstelling tot traditionele berichtgevingen (zoals e-mail), zijn berichten centraal geregistreerd en kunnen ze eenvoudig getoond en gerelateerd worden naast zaken, taken of producten binnen het gemeentelijke landschap. \n\n**URN Pattern**\n\nOpen VTB uses URNs (Uniform Resource Names) to link to other resources, below is a description of the pattern that should be used.\n\n**Syntax:**\n\n`urn:<NID>:<NSS>[#<f-component>]`\n\n**Parts:**\n\n- `urn:` (required): fixed prefix for all URNs, every URN must start with this prefix.\n- `NID` (required): Namespace Identifier: alphanumeric characters, e.g. `nld`.\n- `NSS` (required): Namespace Specific String identifying the object, e.g. `brp:bsn:111222333`.\n- `f-component` (optional): Optional component preceded by `#`, e.g. `#section1`.\n\n**Examples:**\n\n`urn:namespace:component:resource:uuid`, `urn:example:foo#bar`\n\nFor more information, see the official specification: https://datatracker.ietf.org/doc/html/rfc8141\n",
+    "contact": {
+      "email": "standaarden.ondersteuning@vng.nl",
+      "name": "VNG",
+      "url": "https://zaakgerichtwerken.vng.cloud"
+    },
+    "license": {
+      "name": "EUPL 1.2",
+      "url": "https://opensource.org/licenses/EUPL-1.2"
+    }
+  },
+  "paths": {
+    "/berichten": {
+      "get": {
+        "operationId": "berichtenList",
+        "description": "Vraag alle berichten aan.",
+        "summary": "Vraag alle berichten aan.",
+        "parameters": [
+          {
+            "name": "page",
+            "required": false,
+            "in": "query",
+            "description": "Een pagina binnen de gepagineerde set resultaten.",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "pageSize",
+            "required": false,
+            "in": "query",
+            "description": "Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500).",
+            "schema": {
+              "type": "integer"
+            }
+          }
+        ],
+        "tags": [
+          "berichten"
+        ],
+        "security": [
+          {
+            "OpenID": []
+          },
+          {
+            "tokenAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "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/PaginatedBerichtList"
+                }
+              }
+            },
+            "description": ""
+          }
+        }
+      },
+      "post": {
+        "operationId": "berichtenCreate",
+        "description": "Maak een bericht aan.",
+        "summary": "Maak een bericht aan.",
+        "tags": [
+          "berichten"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/Bericht"
+              }
+            }
+          },
+          "required": true
+        },
+        "security": [
+          {
+            "OpenID": []
+          },
+          {
+            "tokenAuth": []
+          }
+        ],
+        "responses": {
+          "201": {
+            "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/Bericht"
+                }
+              }
+            },
+            "description": ""
+          }
+        }
+      }
+    },
+    "/berichten/{uuid}": {
+      "get": {
+        "operationId": "berichtenRetrieve",
+        "description": "Een specifiek bericht opvragen.",
+        "summary": "Een specifiek bericht opvragen.",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "uuid",
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "description": "Unieke identificatiecode (UUID4) voor het Bericht."
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "berichten"
+        ],
+        "security": [
+          {
+            "OpenID": []
+          },
+          {
+            "tokenAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "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/Bericht"
+                }
+              }
+            },
+            "description": ""
+          }
+        }
+      },
+      "patch": {
+        "operationId": "berichtenPartialUpdate",
+        "description": "Werk het veld 'geopendOp' van een bericht bij.",
+        "summary": "Werk het veld 'geopendOp' van een bericht bij.",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "uuid",
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "description": "Unieke identificatiecode (UUID4) voor het Bericht."
+            },
+            "required": true
+          }
+        ],
+        "tags": [
+          "berichten"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/PatchedBerichtGeopendOp"
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "OpenID": []
+          },
+          {
+            "tokenAuth": []
+          }
+        ],
+        "responses": {
+          "200": {
+            "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/Bericht"
+                }
+              }
+            },
+            "description": ""
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "Bericht": {
+        "type": "object",
+        "properties": {
+          "url": {
+            "type": "string",
+            "format": "uri",
+            "readOnly": true,
+            "description": "De unieke URL van het Bericht binnen deze API.",
+            "minLength": 1,
+            "maxLength": 1000
+          },
+          "urn": {
+            "type": "string",
+            "format": "urn",
+            "example": "urn:namespace:component:resource:uuid",
+            "readOnly": true,
+            "description": "De Uniform Resource Name van het Bericht."
+          },
+          "uuid": {
+            "type": "string",
+            "format": "uuid",
+            "readOnly": true,
+            "description": "Unieke identificatiecode (UUID4) voor het Bericht."
+          },
+          "onderwerp": {
+            "type": "string",
+            "description": "Onderwerp van het bericht.",
+            "maxLength": 50
+          },
+          "berichtTekst": {
+            "type": "string",
+            "description": "Tekst van het bericht. URLs worden altijd weergegeven als klikbare URLs op alle portalen. Voor portalen van lokale overheden is de basic syntax van Markdown toegestaan, voor de Mijn Overheid berichtenbox enkel newlines (\\r\\n).",
+            "maxLength": 4000
+          },
+          "publicatiedatum": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true,
+            "description": "Datum/tijd waarop bericht zichtbaar moet worden voor de ontvanger. Dit geldt voor zowel de Mijn Overheid berichtenbox als het portaal van de lokale overheid. De standaardwaarde is de huidige datum/tijd."
+          },
+          "referentie": {
+            "type": "string",
+            "description": "Zenderreferentie / interne referentie.",
+            "maxLength": 25
+          },
+          "ontvanger": {
+            "type": "string",
+            "format": "urn",
+            "example": "urn:namespace:component:resource:uuid",
+            "description": "URN van een NATUURLIJK PERSOON of NIET-NATUURLIJK PERSOON. Bijvoorbeeld: `urn:nld:brp:bsn:111222333`, `urn:nld:hr:kvknummer:444555666` of `urn:nld:hr:kvknummer:444555666:vestigingsnummer:777888999`",
+            "pattern": "^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\\?\\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\\?)*)?(?:\\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\\?)*)?$",
+            "maxLength": 255
+          },
+          "geopendOp": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true,
+            "description": "Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid."
+          },
+          "berichtType": {
+            "type": "string",
+            "description": "Een code voor het technisch identificeren van een bericht soort & origine. Wordt ook gebruikt in de Mijn Overheid berichtenbox.",
+            "maxLength": 8
+          },
+          "handelingsPerspectief": {
+            "type": "string",
+            "description": "De door de toegewezen persoon of bedrijf uit te voeren handeling. Bijvoorbeeld: `lezen`, `naleveren`, `invullen`.",
+            "maxLength": 50
+          },
+          "einddatumHandelingsTermijn": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true,
+            "description": "Datum/tijd waarop handeling afgerond moet zijn."
+          },
+          "mijnOverheidBerichtenbox": {
+            "type": "boolean",
+            "description": "Geeft aan of dit bericht geschikt is voor publicatie in de MijnOverheid Berichtenbox. Als dit op ``False`` staat, is het bericht niet bedoeld voor publicatie in de Berichtenbox."
+          },
+          "bijlagen": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Bijlage"
+            },
+            "description": "Lijst van bijlagen bij het bericht. Let op; In het geval dat dit bericht naar de Mijn Overheid Berichtenbox moet, moet rekening gehouden worden met de requirements van Logius in haar technische aansluithandleiding."
+          }
+        },
+        "required": [
+          "berichtTekst",
+          "mijnOverheidBerichtenbox",
+          "onderwerp",
+          "ontvanger",
+          "url",
+          "urn",
+          "uuid"
+        ]
+      },
+      "Bijlage": {
+        "type": "object",
+        "properties": {
+          "informatieObject": {
+            "type": "string",
+            "format": "urn",
+            "example": "urn:namespace:component:resource:uuid",
+            "description": "URN naar het ENKELVOUDIGINFORMATIEOBJECT. Bijvoorbeeld: `urn:nld:gemeenteutrecht:informatieobject:uuid:717815f6-1939-4fd2-93f0-83d25bad154e`",
+            "pattern": "^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\\?\\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\\?)*)?(?:\\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\\?)*)?$",
+            "maxLength": 255
+          },
+          "omschrijving": {
+            "type": "string",
+            "description": "Een korte omschrijving of de titel van de bijlage. Deze wordt typisch getoond in een portaal.",
+            "maxLength": 40
+          },
+          "isBerichtTypeBijlage": {
+            "type": "boolean",
+            "default": false,
+            "description": "Geeft aan of dit document een standaardbijlage is die vooraf geüpload is in het Berichtenbox Leveranciersportaal. Standaard `false`. Indien `true` moet deze bijlage door het outputmanagementcomponent genegeerd worden - als de Berichtenbox het doelkanaal is."
+          }
+        },
+        "required": [
+          "informatieObject"
+        ]
+      },
+      "PaginatedBerichtList": {
+        "type": "object",
+        "required": [
+          "count",
+          "results"
+        ],
+        "properties": {
+          "count": {
+            "type": "integer",
+            "example": 123
+          },
+          "next": {
+            "type": "string",
+            "nullable": true,
+            "format": "uri",
+            "example": "http://api.example.org/accounts/?page=4"
+          },
+          "previous": {
+            "type": "string",
+            "nullable": true,
+            "format": "uri",
+            "example": "http://api.example.org/accounts/?page=2"
+          },
+          "results": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Bericht"
+            }
+          }
+        }
+      },
+      "PatchedBerichtGeopendOp": {
+        "type": "object",
+        "properties": {
+          "geopendOp": {
+            "type": "string",
+            "format": "date-time",
+            "nullable": true,
+            "description": "Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid."
+          }
+        }
+      }
+    },
+    "securitySchemes": {
+      "OpenID": {
+        "type": "openIdConnect",
+        "openIdConnectUrl": "https://example.com/.well-known/openid-configuration"
+      },
+      "tokenAuth": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "Authorization",
+        "description": "Token-based authentication with required prefix \"Token\""
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "/berichten/api/v1"
+    }
+  ],
+  "tags": [
+    {
+      "name": "berichten"
+    }
+  ]
+}

package/openapi.yaml

@@ -0,0 +1,306 @@
+openapi: 3.0.3
+info:
+  title: Berichten API
+  version: 0.1.0
+  description: |
+    De berichten-service bestaat uit een beschrijving van afspraken, standaarden en referentiecomponenten aangevuld met interactiepatronen, ontwerpbesluiten en aanbevelingen. Het Berichten-patroon biedt een gestandaardiseerde, flexibele oplossing voor de communicatie tussen inwoners, ondernemers en gemeenten via digitale kanalen. Met dit patroon kunnen berichten eenvoudig geregistreerd worden en door verschillende applicaties worden opgehaald, weergegeven en verwerkt. In tegenstelling tot traditionele berichtgevingen (zoals e-mail), zijn berichten centraal geregistreerd en kunnen ze eenvoudig getoond en gerelateerd worden naast zaken, taken of producten binnen het gemeentelijke landschap. 
+
+    **URN Pattern**
+
+    Open VTB uses URNs (Uniform Resource Names) to link to other resources, below is a description of the pattern that should be used.
+
+    **Syntax:**
+
+    `urn:<NID>:<NSS>[#<f-component>]`
+
+    **Parts:**
+
+    - `urn:` (required): fixed prefix for all URNs, every URN must start with this prefix.
+    - `NID` (required): Namespace Identifier: alphanumeric characters, e.g. `nld`.
+    - `NSS` (required): Namespace Specific String identifying the object, e.g. `brp:bsn:111222333`.
+    - `f-component` (optional): Optional component preceded by `#`, e.g. `#section1`.
+
+    **Examples:**
+
+    `urn:namespace:component:resource:uuid`, `urn:example:foo#bar`
+
+    For more information, see the official specification: https://datatracker.ietf.org/doc/html/rfc8141
+  contact:
+    email: standaarden.ondersteuning@vng.nl
+    name: VNG
+    url: https://zaakgerichtwerken.vng.cloud
+  license:
+    name: EUPL 1.2
+    url: https://opensource.org/licenses/EUPL-1.2
+paths:
+  /berichten:
+    get:
+      operationId: berichtenList
+      description: Vraag alle berichten aan.
+      summary: Vraag alle berichten aan.
+      parameters:
+        - name: page
+          required: false
+          in: query
+          description: Een pagina binnen de gepagineerde set resultaten.
+          schema:
+            type: integer
+        - name: pageSize
+          required: false
+          in: query
+          description: 'Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500).'
+          schema:
+            type: integer
+      tags:
+        - berichten
+      security:
+        - OpenID: []
+        - tokenAuth: []
+      responses:
+        '200':
+          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/PaginatedBerichtList'
+          description: ''
+    post:
+      operationId: berichtenCreate
+      description: Maak een bericht aan.
+      summary: Maak een bericht aan.
+      tags:
+        - berichten
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/Bericht'
+        required: true
+      security:
+        - OpenID: []
+        - tokenAuth: []
+      responses:
+        '201':
+          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/Bericht'
+          description: ''
+  /berichten/{uuid}:
+    get:
+      operationId: berichtenRetrieve
+      description: Een specifiek bericht opvragen.
+      summary: Een specifiek bericht opvragen.
+      parameters:
+        - in: path
+          name: uuid
+          schema:
+            type: string
+            format: uuid
+            description: Unieke identificatiecode (UUID4) voor het Bericht.
+          required: true
+      tags:
+        - berichten
+      security:
+        - OpenID: []
+        - tokenAuth: []
+      responses:
+        '200':
+          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/Bericht'
+          description: ''
+    patch:
+      operationId: berichtenPartialUpdate
+      description: Werk het veld 'geopendOp' van een bericht bij.
+      summary: Werk het veld 'geopendOp' van een bericht bij.
+      parameters:
+        - in: path
+          name: uuid
+          schema:
+            type: string
+            format: uuid
+            description: Unieke identificatiecode (UUID4) voor het Bericht.
+          required: true
+      tags:
+        - berichten
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/PatchedBerichtGeopendOp'
+      security:
+        - OpenID: []
+        - tokenAuth: []
+      responses:
+        '200':
+          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/Bericht'
+          description: ''
+components:
+  schemas:
+    Bericht:
+      type: object
+      properties:
+        url:
+          type: string
+          format: uri
+          readOnly: true
+          description: De unieke URL van het Bericht binnen deze API.
+          minLength: 1
+          maxLength: 1000
+        urn:
+          type: string
+          format: urn
+          example: urn:namespace:component:resource:uuid
+          readOnly: true
+          description: De Uniform Resource Name van het Bericht.
+        uuid:
+          type: string
+          format: uuid
+          readOnly: true
+          description: Unieke identificatiecode (UUID4) voor het Bericht.
+        onderwerp:
+          type: string
+          description: Onderwerp van het bericht.
+          maxLength: 50
+        berichtTekst:
+          type: string
+          description: Tekst van het bericht. URLs worden altijd weergegeven als klikbare URLs op alle portalen. Voor portalen van lokale overheden is de basic syntax van Markdown toegestaan, voor de Mijn Overheid berichtenbox enkel newlines (\r\n).
+          maxLength: 4000
+        publicatiedatum:
+          type: string
+          format: date-time
+          nullable: true
+          description: Datum/tijd waarop bericht zichtbaar moet worden voor de ontvanger. Dit geldt voor zowel de Mijn Overheid berichtenbox als het portaal van de lokale overheid. De standaardwaarde is de huidige datum/tijd.
+        referentie:
+          type: string
+          description: Zenderreferentie / interne referentie.
+          maxLength: 25
+        ontvanger:
+          type: string
+          format: urn
+          example: urn:namespace:component:resource:uuid
+          description: 'URN van een NATUURLIJK PERSOON of NIET-NATUURLIJK PERSOON. Bijvoorbeeld: `urn:nld:brp:bsn:111222333`, `urn:nld:hr:kvknummer:444555666` of `urn:nld:hr:kvknummer:444555666:vestigingsnummer:777888999`'
+          pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
+          maxLength: 255
+        geopendOp:
+          type: string
+          format: date-time
+          nullable: true
+          description: Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid.
+        berichtType:
+          type: string
+          description: Een code voor het technisch identificeren van een bericht soort & origine. Wordt ook gebruikt in de Mijn Overheid berichtenbox.
+          maxLength: 8
+        handelingsPerspectief:
+          type: string
+          description: 'De door de toegewezen persoon of bedrijf uit te voeren handeling. Bijvoorbeeld: `lezen`, `naleveren`, `invullen`.'
+          maxLength: 50
+        einddatumHandelingsTermijn:
+          type: string
+          format: date-time
+          nullable: true
+          description: Datum/tijd waarop handeling afgerond moet zijn.
+        mijnOverheidBerichtenbox:
+          type: boolean
+          description: Geeft aan of dit bericht geschikt is voor publicatie in de MijnOverheid Berichtenbox. Als dit op ``False`` staat, is het bericht niet bedoeld voor publicatie in de Berichtenbox.
+        bijlagen:
+          type: array
+          items:
+            $ref: '#/components/schemas/Bijlage'
+          description: Lijst van bijlagen bij het bericht. Let op; In het geval dat dit bericht naar de Mijn Overheid Berichtenbox moet, moet rekening gehouden worden met de requirements van Logius in haar technische aansluithandleiding.
+      required:
+        - berichtTekst
+        - mijnOverheidBerichtenbox
+        - onderwerp
+        - ontvanger
+        - url
+        - urn
+        - uuid
+    Bijlage:
+      type: object
+      properties:
+        informatieObject:
+          type: string
+          format: urn
+          example: urn:namespace:component:resource:uuid
+          description: 'URN naar het ENKELVOUDIGINFORMATIEOBJECT. Bijvoorbeeld: `urn:nld:gemeenteutrecht:informatieobject:uuid:717815f6-1939-4fd2-93f0-83d25bad154e`'
+          pattern: ^urn:[A-Za-z0-9](?:[A-Za-z0-9]|-){0,30}[A-Za-z0-9]:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/)*(?:\?\+(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:\?=(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?(?:#(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])(?:(?:[A-Za-z0-9]|[-._~]|%[0-9A-Fa-f][0-9A-Fa-f]|[!$&'()*+,;=]|[:@])|/|\?)*)?$
+          maxLength: 255
+        omschrijving:
+          type: string
+          description: Een korte omschrijving of de titel van de bijlage. Deze wordt typisch getoond in een portaal.
+          maxLength: 40
+        isBerichtTypeBijlage:
+          type: boolean
+          default: false
+          description: Geeft aan of dit document een standaardbijlage is die vooraf geüpload is in het Berichtenbox Leveranciersportaal. Standaard `false`. Indien `true` moet deze bijlage door het outputmanagementcomponent genegeerd worden - als de Berichtenbox het doelkanaal is.
+      required:
+        - informatieObject
+    PaginatedBerichtList:
+      type: object
+      required:
+        - count
+        - results
+      properties:
+        count:
+          type: integer
+          example: 123
+        next:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?page=4
+        previous:
+          type: string
+          nullable: true
+          format: uri
+          example: http://api.example.org/accounts/?page=2
+        results:
+          type: array
+          items:
+            $ref: '#/components/schemas/Bericht'
+    PatchedBerichtGeopendOp:
+      type: object
+      properties:
+        geopendOp:
+          type: string
+          format: date-time
+          nullable: true
+          description: Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid.
+  securitySchemes:
+    OpenID:
+      type: openIdConnect
+      openIdConnectUrl: https://example.com/.well-known/openid-configuration
+    tokenAuth:
+      type: apiKey
+      in: header
+      name: Authorization
+      description: Token-based authentication with required prefix "Token"
+servers:
+  - url: /berichten/api/v1
+tags:
+  - name: berichten

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@vng-api/openvtb-berichten",
+  "version": "0.1.0",
+  "description": "OpenAPI-specificatie voor Berichten API — De berichten-service bestaat uit een beschrijving van afspraken, standaarden en referentiecomponenten aangevuld met interactiepatronen, ontwerpbesluiten en aanbevelingen. Het Berichten-patroon biedt een gesta",
+  "main": "openapi.json",
+  "exports": {
+    ".": "./openapi.json",
+    "./openapi.json": "./openapi.json",
+    "./openapi.yaml": "./openapi.yaml"
+  },
+  "files": [
+    "openapi.yaml",
+    "openapi.json",
+    "README.md"
+  ],
+  "keywords": [
+    "openapi",
+    "vng",
+    "api",
+    "openvtb-berichten"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/VNG-Realisatie/Interactie-APIs.git",
+    "directory": "apis/rest/openvtb-berichten"
+  },
+  "homepage": "https://github.com/VNG-Realisatie/Interactie-APIs",
+  "publishConfig": {
+    "access": "public"
+  }
+}