diff options
author | Austin S. Hemmelgarn <austin@netdata.cloud> | 2023-07-25 13:10:25 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-07-25 13:10:25 -0400 |
commit | f577a63ac044e8d4e038eaba526ad83bb5d16e79 (patch) | |
tree | d5ea3fbced186a51bd0bb3fc36f51c8b0a6cfd04 /integrations/schemas | |
parent | 00aa11bbfb077b9a1478dbd306aea5baf82c328d (diff) |
Add a schema for the categories.yaml file. (#15521)
Diffstat (limited to 'integrations/schemas')
-rw-r--r-- | integrations/schemas/categories.json | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/integrations/schemas/categories.json b/integrations/schemas/categories.json new file mode 100644 index 0000000000..1814fb3331 --- /dev/null +++ b/integrations/schemas/categories.json @@ -0,0 +1,53 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "array", + "title": "Category information for integrations.", + "items": { + "$ref": "#/$defs/category" + }, + "$defs": { + "category": { + "type": "object", + "description": "An entry for a single category.", + "properties": { + "id": { + "type": "string", + "minLength": 1, + "description": "A unique ID for the category. Recommended format is a dot-separated list of categories that are parents of this category, followed by a unique value for this category. Must be URL safe." + }, + "name": { + "type": "string", + "minLength": 1, + "description": "The display name for the category." + }, + "description": { + "type": "string", + "description": "A description of the category." + }, + "most_popular": { + "type": "boolean", + "description": "Indicates if the category should show up in the initial list of categories, or only in the full expanded list." + }, + "priority": { + "type": "integer", + "description": "Indicates sort order for categories that are marked as most popular." + }, + "children": { + "type": "array", + "description": "A list of categories that are children of this category.", + "items": { + "$ref": "#/$defs/category" + } + } + }, + "required": [ + "id", + "name", + "description", + "most_popular", + "priority", + "children" + ] + } + } +} |