summaryrefslogtreecommitdiffstats
path: root/integrations/schemas/notification.json
diff options
context:
space:
mode:
Diffstat (limited to 'integrations/schemas/notification.json')
-rw-r--r--integrations/schemas/notification.json87
1 files changed, 87 insertions, 0 deletions
diff --git a/integrations/schemas/notification.json b/integrations/schemas/notification.json
new file mode 100644
index 00000000..2596ca44
--- /dev/null
+++ b/integrations/schemas/notification.json
@@ -0,0 +1,87 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "title": "Netdata notification mechanism metadata.",
+ "oneOf": [
+ {
+ "$ref": "#/$defs/entry"
+ },
+ {
+ "type": "array",
+ "minLength": 1,
+ "items": {
+ "$ref": "#/$defs/entry"
+ }
+ }
+ ],
+ "$defs": {
+ "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"
+ ]
+ },
+ "global_setup": {
+ "type": "object",
+ "description": "Flags that show which global setup sections are relevant for this notification method.",
+ "properties": {
+ "severity_filtering": {
+ "type": "boolean"
+ },
+ "http_proxy": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "severity_filtering",
+ "http_proxy"
+ ]
+ },
+ "setup": {
+ "oneOf": [
+ {
+ "$ref": "./shared.json#/$defs/short_setup"
+ },
+ {
+ "$ref": "./shared.json#/$defs/full_setup"
+ }
+ ]
+ },
+ "troubleshooting": {
+ "$ref": "./shared.json#/$defs/troubleshooting"
+ }
+ },
+ "required": [
+ "id",
+ "meta",
+ "keywords",
+ "overview",
+ "setup"
+ ]
+ }
+ }
+}