master
json 97 lines 3.39 KB
Raw
1 {
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "Netdata Logs integrations 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 logs integration.",
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 "properties": {
33 "description": {
34 "type": "string",
35 "description": "General description of what the integration does."
36 },
37 "visualization": {
38 "type": "object",
39 "properties": {
40 "description": {
41 "type": "string",
42 "description": "How the user can access the data provided by the integration"
43 }
44 },
45 "required": [
46 "description"
47 ]
48 },
49 "key_features": {
50 "type": "object",
51 "properties": {
52 "description": {
53 "type": "string",
54 "description": "The key features of the integration."
55 }
56 },
57 "required": [
58 "description"
59 ]
60 }
61 },
62 "required": [
63 "description",
64 "visualization",
65 "key_features"
66 ]
67 },
68 "setup": {
69 "type": "object",
70 "properties": {
71 "prerequisites": {
72 "type": "object",
73 "properties": {
74 "description": {
75 "type": "string",
76 "description": "Prerequisites of getting the integration working. For Log Functions only a Netdata account should be needed."
77 }
78 },
79 "required": [
80 "description"
81 ]
82 },
83 "required": [
84 "prerequisites"
85 ]
86 }
87 }
88 },
89 "required": [
90 "id",
91 "meta",
92 "keywords",
93 "overview"
94 ]
95 }
96 }
97 }