Add schema and examples for notification method metadata. (#15549)

2 files changed, 99 insertions, 0 deletions

diff --git a/integrations/notifications.yaml b/integrations/notifications.yaml
new file mode 100644
index 0000000000..11dcc6e5e4
--- /dev/null
+++ b/integrations/notifications.yaml
@@ -0,0 +1,39 @@
+- id: ''
+  meta:
+    name: ''
+    link: ''
+    categories: []
+    icon_filename: ''
+  keywords: []
+  overview:
+    notification_description: ''
+    notification_limitations: ''
+  setup:
+    prerequisites:
+      list:
+        - title: ''
+          description: ''
+    configuration:
+      file:
+        name: ''
+        description: ''
+      options:
+        description: ''
+        folding:
+          title: ''
+          enabled: true
+        list:
+          - name: ''
+            default_value: ''
+            description: ''
+            required: false
+      examples:
+        folding:
+          enabled: true
+          title: ''
+        list:
+          - name: ''
+            folding:
+              enabled: false
+            description: ''
+            config: ''
diff --git a/integrations/schemas/notification.json b/integrations/schemas/notification.json
new file mode 100644
index 0000000000..b837047106
--- /dev/null
+++ b/integrations/schemas/notification.json
@@ -0,0 +1,60 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Netdata notification mechanism metadata.",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/entry"
+    },
+    {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/entry"
+      }
+    }
+  ],
+  "$def": {
+    "entry": {
+      "type": "object",
+      "description": "Data for a single notification method.",
+      "properties": {
+        "id": {
+          "$ref": "./shared.json#/$defs/id"
+        },
+        "meta": {
+          "$ref": "./shared.json#/$defs/instance"
+        },
+        "keywords": {
+          "$ref": "./shared.json#/$defs/keywords"
+        },
+        "overview": {
+          "type": "object",
+          "description": "General information about the notification method.",
+          "properties": {
+            "notification_description": {
+              "type": "string",
+              "description": "General description of what the notification method does."
+            },
+            "notification_limitations": {
+              "type": "string",
+              "description": "Explanation of any limitations of the notification method."
+            }
+          },
+          "required": [
+            "notification_description",
+            "notification_limitations"
+          ]
+        },
+        "setup": {
+          "$ref": "./shared.json#/$defs/setup"
+        }
+      },
+      "required": [
+        "id",
+        "meta",
+        "keywords",
+        "overview",
+        "setup"
+      ]
+    }
+  }
+}