summaryrefslogtreecommitdiffstats
path: root/integrations/schemas
diff options
context:
space:
mode:
authorAustin S. Hemmelgarn <austin@netdata.cloud>2023-08-02 08:32:17 -0400
committerGitHub <noreply@github.com>2023-08-02 18:02:17 +0530
commitf1a28f5137b4c76d9b5405c2a12f7164895f7efe (patch)
tree4e85c4b8bed9deb29cbfbc6e65f88a2cb65aaf95 /integrations/schemas
parent256f22ff0955cbdccdc55af3efb3667153bd2c66 (diff)
Fix handling of troubleshooting section in integrations. (#15700)
* Fix handling of troubleshooting section in integrations. * Fix plugin_name key path.
Diffstat (limited to 'integrations/schemas')
-rw-r--r--integrations/schemas/collector.json38
-rw-r--r--integrations/schemas/exporter.json3
-rw-r--r--integrations/schemas/notification.json3
-rw-r--r--integrations/schemas/shared.json39
4 files changed, 46 insertions, 37 deletions
diff --git a/integrations/schemas/collector.json b/integrations/schemas/collector.json
index dedbf8dd49..ba5d9f9d19 100644
--- a/integrations/schemas/collector.json
+++ b/integrations/schemas/collector.json
@@ -222,43 +222,7 @@
"$ref": "./shared.json#/$defs/full_setup"
},
"troubleshooting": {
- "type": "object",
- "description": "Information needed to troubleshoot issues with this collector.",
- "properties": {
- "problems": {
- "type": "object",
- "description": "Common problems that users face again and again... and their solutions.",
- "properties": {
- "list": {
- "type": "array",
- "description": "List of common problems.",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "Problem name."
- },
- "description": {
- "type": "string",
- "description": "Explanation of the problem and its solution."
- }
- }
- },
- "required": [
- "name",
- "description"
- ]
- }
- },
- "required": [
- "list"
- ]
- }
- },
- "required": [
- "problems"
- ]
+ "$ref": "./shared.json#/$defs/troubleshooting"
},
"alerts": {
"type": "array",
diff --git a/integrations/schemas/exporter.json b/integrations/schemas/exporter.json
index 00d8986f29..51c45cabba 100644
--- a/integrations/schemas/exporter.json
+++ b/integrations/schemas/exporter.json
@@ -46,6 +46,9 @@
},
"setup": {
"$ref": "./shared.json#/$defs/full_setup"
+ },
+ "troubleshooting": {
+ "$ref": "./shared.json#/$defs/troubleshooting"
}
},
"required": [
diff --git a/integrations/schemas/notification.json b/integrations/schemas/notification.json
index 1027f9b3d9..2596ca441e 100644
--- a/integrations/schemas/notification.json
+++ b/integrations/schemas/notification.json
@@ -70,6 +70,9 @@
"$ref": "./shared.json#/$defs/full_setup"
}
]
+ },
+ "troubleshooting": {
+ "$ref": "./shared.json#/$defs/troubleshooting"
}
},
"required": [
diff --git a/integrations/schemas/shared.json b/integrations/schemas/shared.json
index a30d721697..5aa926c3f3 100644
--- a/integrations/schemas/shared.json
+++ b/integrations/schemas/shared.json
@@ -249,6 +249,45 @@
"configuration"
]
},
+ "troubleshooting": {
+ "type": "object",
+ "description": "Information needed to troubleshoot issues with this collector.",
+ "properties": {
+ "problems": {
+ "type": "object",
+ "description": "Common problems that users face again and again... and their solutions.",
+ "properties": {
+ "list": {
+ "type": "array",
+ "description": "List of common problems.",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Problem name."
+ },
+ "description": {
+ "type": "string",
+ "description": "Explanation of the problem and its solution."
+ }
+ }
+ },
+ "required": [
+ "name",
+ "description"
+ ]
+ }
+ },
+ "required": [
+ "list"
+ ]
+ }
+ },
+ "required": [
+ "problems"
+ ]
+ },
"_folding": {
"type": "object",
"description": "Content folding settings.",