master
json 87 lines 2.19 KB
Raw
1 {
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "Netdata notification mechanism metadata.",
4 "oneOf": [
5 {
6 "$ref": "#/$defs/entry"
7 },
8 {
9 "type": "array",
10 "minLength": 1,
11 "items": {
12 "$ref": "#/$defs/entry"
13 }
14 }
15 ],
16 "$defs": {
17 "entry": {
18 "type": "object",
19 "description": "Data for a single notification method.",
20 "properties": {
21 "id": {
22 "$ref": "./shared.json#/$defs/id"
23 },
24 "meta": {
25 "$ref": "./shared.json#/$defs/instance"
26 },
27 "keywords": {
28 "$ref": "./shared.json#/$defs/keywords"
29 },
30 "overview": {
31 "type": "object",
32 "description": "General information about the notification method.",
33 "properties": {
34 "notification_description": {
35 "type": "string",
36 "description": "General description of what the notification method does."
37 },
38 "notification_limitations": {
39 "type": "string",
40 "description": "Explanation of any limitations of the notification method."
41 }
42 },
43 "required": [
44 "notification_description",
45 "notification_limitations"
46 ]
47 },
48 "global_setup": {
49 "type": "object",
50 "description": "Flags that show which global setup sections are relevant for this notification method.",
51 "properties": {
52 "severity_filtering": {
53 "type": "boolean"
54 },
55 "http_proxy": {
56 "type": "boolean"
57 }
58 },
59 "required": [
60 "severity_filtering",
61 "http_proxy"
62 ]
63 },
64 "setup": {
65 "oneOf": [
66 {
67 "$ref": "./shared.json#/$defs/short_setup"
68 },
69 {
70 "$ref": "./shared.json#/$defs/full_setup"
71 }
72 ]
73 },
74 "troubleshooting": {
75 "$ref": "./shared.json#/$defs/troubleshooting"
76 }
77 },
78 "required": [
79 "id",
80 "meta",
81 "keywords",
82 "overview",
83 "setup"
84 ]
85 }
86 }
87 }