diff options
| author | Fotis Voutsas <fotis@netdata.cloud> | 2023-07-14 18:20:18 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-07-14 18:20:18 +0300 |
| commit | 17d271d62be1fe9f301a1907d8aba9638731b46d (patch) | |
| tree | 2cb5ffa1486da173e862d1b55e770647468a3d21 /docs | |
| parent | 5073741ac22993bf9fbabe4e69027a28e7e69398 (diff) | |
Create categories.yaml (#15385)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/.templates/integration/schema.json | 28 |
1 files changed, 12 insertions, 16 deletions
diff --git a/docs/.templates/integration/schema.json b/docs/.templates/integration/schema.json index 1e2ce85337..5f2b2a8537 100644 --- a/docs/.templates/integration/schema.json +++ b/docs/.templates/integration/schema.json @@ -11,30 +11,26 @@ "type": "array", "items": { "type": "object", - "description": "The concept of IDs between categories is used, so we can handle nested categories. That way they will be able to mention their parent, and we should be able to make the structure of categories. Every category's ID will be used by the various integrations too to mention in which category they lie. Along with this, a priority field is needed to define the ordering on a menu-level.", + "description": "", "properties": { - "name": { + "id": { "type": "string", - "description": "Name of the category. This is the actual name of the category or subcategory, (e.g. Web Servers, Operating Systems, Databases)." + "description": "ID of the category, can be found in integrations/categories.yaml for every category." }, "description": { "type": "string", - "description": "Text that will be presented below the category title." + "description": "Text that will be presented below the category title, or that will be accompanying the category in the UI in any form." }, "priority": { "type": "integer", - "description": "Priority of the category. A number expressing where the category should be in the menu. The smaller the number the higher the priority, so a category with priority 1 would be above a category with a priority of 50 in terms of menu ordering." + "description": "Priority of the category. A number expressing where the category should be in the menu. Currently, a static number gets assigned to all categories, with a higher priority one for the most-popular flagged categories." }, - "id": { - "type": "string", - "description": "ID of the category that will be used by integrations, this is a unique number for each category that will be used by its children to refer to it as their parent." - }, - "parent_id": { - "type": [ - "null", - "string" - ], - "description": "The category's parent ID. If this category is a subcategory, then it needs to mention its parent, where it belongs to. Make it null if no parent and this is a top level category." + "children": { + "type": "array", + "description": "an array that recursively has the same elements as the parent.", + "items": { + "$ref": "#" + } } } } @@ -62,7 +58,7 @@ "properties": { "category_id": { "type": "string", - "description": "The category_ID for this integration." + "description": "The category_ID for this integration. This is the category ID mentioned inside integrations/category.yaml, for the respective category." }, "priority": { "type": "integer", |