| 1 | { |
| 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | "type": "object", |
| 4 | "title": "Netdata Integrations file", |
| 5 | "properties": { |
| 6 | "categories": { |
| 7 | "type": "object", |
| 8 | "description": "A list defining all the available categories for the integrations.", |
| 9 | "properties": { |
| 10 | "list": { |
| 11 | "type": "array", |
| 12 | "items": { |
| 13 | "type": "object", |
| 14 | "description": "", |
| 15 | "properties": { |
| 16 | "id": { |
| 17 | "type": "string", |
| 18 | "description": "ID of the category, can be found in integrations/categories.yaml for every category." |
| 19 | }, |
| 20 | "description": { |
| 21 | "type": "string", |
| 22 | "description": "Text that will be presented below the category title, or that will be accompanying the category in the UI in any form." |
| 23 | }, |
| 24 | "children": { |
| 25 | "type": "array", |
| 26 | "description": "an array that recursively has the same elements as the parent.", |
| 27 | "items": { |
| 28 | "$ref": "#" |
| 29 | } |
| 30 | } |
| 31 | } |
| 32 | } |
| 33 | } |
| 34 | } |
| 35 | }, |
| 36 | "integrations": { |
| 37 | "type": "array", |
| 38 | "description": "A list of integration elements, combination of metadata.yaml and other sources.", |
| 39 | "items": { |
| 40 | "type": "object", |
| 41 | "properties": { |
| 42 | "id": { |
| 43 | "type": "string", |
| 44 | "description": "A unique string identifier for the integration." |
| 45 | }, |
| 46 | "name": { |
| 47 | "type": "string" |
| 48 | }, |
| 49 | "categories": { |
| 50 | "type": "array", |
| 51 | "description": "an array of categories that the integration belongs to", |
| 52 | "items": { |
| 53 | "type": "object", |
| 54 | "properties": { |
| 55 | "category_id": { |
| 56 | "type": "string", |
| 57 | "description": "The category_ID for this integration. This is the category ID mentioned inside integrations/category.yaml, for the respective category." |
| 58 | } |
| 59 | } |
| 60 | } |
| 61 | }, |
| 62 | "icon": { |
| 63 | "type": "string", |
| 64 | "description": "path to the icon for this integration." |
| 65 | }, |
| 66 | "keywords": { |
| 67 | "type": "array", |
| 68 | "description": "An array of terms related to the integration.", |
| 69 | "items": { |
| 70 | "type": "string" |
| 71 | } |
| 72 | }, |
| 73 | "overview": { |
| 74 | "type": "string", |
| 75 | "description": "The text that will go in the top of the page, in markdown format." |
| 76 | }, |
| 77 | "metrics": { |
| 78 | "type": "string", |
| 79 | "description": "Metrics section rendered in markdown format." |
| 80 | }, |
| 81 | "alerts": { |
| 82 | "type": "string", |
| 83 | "description": "Alerts section rendered in markdown format." |
| 84 | }, |
| 85 | "setup": { |
| 86 | "type": "string", |
| 87 | "description": "Setup section rendered in markdown format." |
| 88 | }, |
| 89 | "troubleshooting": { |
| 90 | "type": "string", |
| 91 | "description": "troubleshooting section rendered in markdown format." |
| 92 | }, |
| 93 | "related_resources": { |
| 94 | "type": "string", |
| 95 | "description": "Related Resources section rendered in markdown format." |
| 96 | } |
| 97 | } |
| 98 | } |
| 99 | } |
| 100 | } |
| 101 | } |