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. (#15549)
This commit is contained in:
parent
b12cadca99
commit
85d122f8a6
3 changed files with 138 additions and 0 deletions
39
health/notifications/sample-metadata.yaml
Normal file
39
health/notifications/sample-metadata.yaml
Normal 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: ''
|
39
integrations/notifications.yaml
Normal file
39
integrations/notifications.yaml
Normal 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: ''
|
60
integrations/schemas/notification.json
Normal file
60
integrations/schemas/notification.json
Normal 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"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Add table
Reference in a new issue