From cdc528a21bd03ef895d19d654b9ea8dd4731ac9b Mon Sep 17 00:00:00 2001
From: Anna Shamray <anna.shamray@maykinmedia.nl>
Date: Mon, 12 Aug 2024 11:59:24 +0200
Subject: [PATCH] :memo:
 [https://github.com/open-zaak/open-notificaties/issues/171] generate
 notificaties.md file

---
 src/notificaties.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 src/notificaties.md

diff --git a/src/notificaties.md b/src/notificaties.md
new file mode 100644
index 00000000..b559a1f7
--- /dev/null
+++ b/src/notificaties.md
@@ -0,0 +1,32 @@
+## Notificaties
+## Berichtkenmerken voor Objects API
+
+Kanalen worden typisch per component gedefinieerd. Producers versturen berichten op bepaalde kanalen,
+consumers ontvangen deze. Consumers abonneren zich via een notificatiecomponent (zoals <a href="https://notificaties-api.vng.cloud/api/v1/schema/" rel="nofollow">https://notificaties-api.vng.cloud/api/v1/schema/</a>) op berichten.
+
+Hieronder staan de kanalen beschreven die door deze component gebruikt worden, met de kenmerken bij elk bericht.
+
+De architectuur van de notificaties staat beschreven op <a href="https://github.com/VNG-Realisatie/notificaties-api" rel="nofollow">https://github.com/VNG-Realisatie/notificaties-api</a>.
+
+
+### objecten
+
+**Kanaal**
+`objecten`
+
+**Main resource**
+
+`object`
+
+
+
+**Kenmerken**
+
+* `object_type`: OBJECTTYPE in Objecttypes API
+
+**Resources en acties**
+
+
+* <code>objectrecord</code>: create, update, destroy, create, update, destroy
+
+