diff options
Diffstat (limited to 'integrations/schemas')
| -rw-r--r-- | integrations/schemas/agent_notification.json (renamed from integrations/schemas/notification.json) | 28 | ||||
| -rw-r--r-- | integrations/schemas/cloud_notification.json | 68 | ||||
| -rw-r--r-- | integrations/schemas/logs.json | 97 |
3 files changed, 179 insertions, 14 deletions
diff --git a/integrations/schemas/notification.json b/integrations/schemas/agent_notification.json index 2596ca441..f157a65d9 100644 --- a/integrations/schemas/notification.json +++ b/integrations/schemas/agent_notification.json @@ -46,20 +46,20 @@ ] }, "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" - } + "type": "object", + "description": "Flags that show which global setup sections are relevant for this notification method.", + "properties": { + "severity_filtering": { + "type": "boolean" }, - "required": [ - "severity_filtering", - "http_proxy" - ] + "http_proxy": { + "type": "boolean" + } + }, + "required": [ + "severity_filtering", + "http_proxy" + ] }, "setup": { "oneOf": [ @@ -84,4 +84,4 @@ ] } } -} +}
\ No newline at end of file diff --git a/integrations/schemas/cloud_notification.json b/integrations/schemas/cloud_notification.json new file mode 100644 index 000000000..60bd66e8f --- /dev/null +++ b/integrations/schemas/cloud_notification.json @@ -0,0 +1,68 @@ +{ + "$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" + }, + "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", + "setup" + ] + } + } +}
\ No newline at end of file diff --git a/integrations/schemas/logs.json b/integrations/schemas/logs.json new file mode 100644 index 000000000..8209dc979 --- /dev/null +++ b/integrations/schemas/logs.json @@ -0,0 +1,97 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "title": "Netdata Logs integrations metadata.", + "oneOf": [ + { + "$ref": "#/$defs/entry" + }, + { + "type": "array", + "minLength": 1, + "items": { + "$ref": "#/$defs/entry" + } + } + ], + "$defs": { + "entry": { + "type": "object", + "description": "Data for a single logs integration.", + "properties": { + "id": { + "$ref": "./shared.json#/$defs/id" + }, + "meta": { + "$ref": "./shared.json#/$defs/instance" + }, + "keywords": { + "$ref": "./shared.json#/$defs/keywords" + }, + "overview": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "General description of what the integration does." + }, + "visualization": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "How the user can access the data provided by the integration" + } + }, + "required": [ + "description" + ] + }, + "key_features": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The key features of the integration." + } + }, + "required": [ + "description" + ] + } + }, + "required": [ + "description", + "visualization", + "key_features" + ] + }, + "setup": { + "type": "object", + "properties": { + "prerequisites": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Prerequisites of getting the integration working. For Log Functions only a Netdata account should be needed." + } + }, + "required": [ + "description" + ] + }, + "required": [ + "prerequisites" + ] + } + } + }, + "required": [ + "id", + "meta", + "keywords", + "overview" + ] + } + } +}
\ No newline at end of file |