0
0
mirror of https://github.com/netdata/netdata.git synced 2024-12-12 08:07:28 +00:00
netdata_netdata/integrations/schemas/agent_notification.json
Fotis Voutsas 0ab7826301
Remove the overview section from cloud notif. integrations (#18754)
Co-authored-by: ilyam8 <ilya@netdata.cloud>
2024-10-14 08:23:50 +00:00

87 lines
2.2 KiB
JSON

{
"$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"
]
}
}
}