0
0
Fork 0
mirror of https://github.com/netdata/netdata.git synced 2025-04-10 16:17:36 +00:00

Add schema and examples for notification method metadata. ()

This commit is contained in:
Austin S. Hemmelgarn 2023-07-26 12:53:52 -04:00 committed by GitHub
parent b12cadca99
commit 85d122f8a6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 138 additions and 0 deletions
health/notifications
integrations

View file

@ -0,0 +1,39 @@
id: ''
meta:
name: ''
link: ''
categories: []
icon_filename: ''
keywords: []
overview:
exporter_description: ''
exporter_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: ''

View file

@ -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: ''

View file

@ -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"
]
}
}
}