🗃️ Updates shcema title and description attributes

This commit is contained in:
Alicia Sykes 2021-10-27 22:01:28 +01:00
parent 08072f1fb6
commit b3b84c6a13
1 changed files with 35 additions and 17 deletions

View File

@ -285,7 +285,7 @@
"cssThemes": { "cssThemes": {
"title": "Additional CSS Themes", "title": "Additional CSS Themes",
"type": "array", "type": "array",
"description": "Theme names to be added to the dropdown", "description": "Theme names to be added to the dropdown, once added you can then add custom CSS to style your theme",
"items": { "items": {
"type": "string" "type": "string"
} }
@ -293,11 +293,11 @@
"customColors": { "customColors": {
"title": "Custom Colors", "title": "Custom Colors",
"type": "object", "type": "object",
"description": "Set a custom color palette for any theme" "description": "Set a custom color palette for any theme, see docs for more info"
}, },
"externalStyleSheet": { "externalStyleSheet": {
"title": "External Stylesheets", "title": "External Stylesheets",
"description": "URL or URLs of external stylesheets to add to dropdown/ load", "description": "List of URLs of external stylesheets to add to dropdown/ load",
"type": "array", "type": "array",
"items": { "items": {
"type": "string" "type": "string"
@ -306,7 +306,7 @@
"customCss": { "customCss": {
"title": "Custom CSS", "title": "Custom CSS",
"type": "string", "type": "string",
"description": "Any custom CSS overides, must be minified" "description": "Any custom CSS overides to be applied globally, should be minified"
}, },
"hideComponents": { "hideComponents": {
"title": "Hidden Components", "title": "Hidden Components",
@ -626,24 +626,29 @@
], ],
"properties": { "properties": {
"title": { "title": {
"title": "Item Text",
"type": "string", "type": "string",
"description": "Text shown on the item" "description": "Title of the item"
}, },
"description": { "description": {
"title": "Description",
"type": "string", "type": "string",
"nullable": true, "nullable": true,
"description": "Short description, shown on hover or in a tooltip" "description": "Short description, shown on hover or in a tooltip"
}, },
"icon": { "icon": {
"title": "Icon",
"type": "string", "type": "string",
"nullable": true, "nullable": true,
"description": "An icon, either as a font-awesome identifier, local or remote URL, or the word favicon or generative" "description": "An icon, either as a font-awesome, simple-icon or mdi identifier, emoji, favicon, generative or the URL/ path to a local or remote icon asset"
}, },
"url": { "url": {
"title": "Service URL",
"type": "string", "type": "string",
"description": "The destination to navigate to when item is clicked" "description": "The destination to navigate to when item is clicked, expressed as a valid URL, IP or hostname"
}, },
"target": { "target": {
"title": "Opening Method",
"type": "string", "type": "string",
"enum": [ "enum": [
"newtab", "newtab",
@ -654,45 +659,58 @@
"workspace" "workspace"
], ],
"default": "newtab", "default": "newtab",
"description": "Opening method, when item is clicked" "description": "Where / how the item is opened when it's clicked"
}, },
"hotkey": { "hotkey": {
"title": "Hot Key",
"type": "number", "type": "number",
"description": "A numeric shortcut key, between 0 and 9. Useful for quickly launching frequently used applications" "description": "A numeric shortcut key, between 0 and 9. Useful for quickly launching frequently used applications"
}, },
"tags": { "tags": {
"title": "Tags",
"type": "array", "type": "array",
"description": "Tags, which can be used for improved search", "description": "A list of tags for improved search. Separate using a comma",
"maxItems": 12, "maxItems": 12,
"items": { "items": {
"type": "string" "type": "string"
} }
}, },
"color": {
"type": "string",
"description": "A custom fill color of the item"
},
"provider": { "provider": {
"title": "Provider",
"type": "string", "type": "string",
"description": "Provider name, e.g. Microsoft" "description": "Provider name, e.g. Microsoft, Nebucasa, DigitalOcean, etc"
}, },
"statusCheck": { "statusCheck": {
"title": "Enable Status Check",
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Whether or not to display online/ offline status for this service. Will override appConfig.statusCheck" "description": "Whether or not to display online/ offline status for this service. Will override appConfig.statusCheck"
}, },
"statusCheckUrl": { "statusCheckUrl": {
"title": "Status Check URL",
"type": "string", "type": "string",
"description": "If you've enabled statusCheck, and want to use a different URL to what is defined under the item, then specify it here" "description": "Custom status check endpoint for this item. Useful if the default URL doesn't return 200, or if your service has a dedicated status check endpoint"
}, },
"statusCheckHeaders": { "statusCheckHeaders": {
"title": "Status Check Headers",
"type": "object", "type": "object",
"description": " If you're endpoint requires any specific headers for the status checking, then define them here" "description": " Custom headers for status checking, useful if your service requires authorization headers to return a 200"
}, },
"statusCheckAllowInsecure": { "statusCheckAllowInsecure": {
"title": "Status Check Disable SSL",
"type": "boolean", "type": "boolean",
"default": false, "default": false,
"description": "Allows for running status checks on insecure content/ non-HTTPS apps" "description": "Allows for running status checks on insecure content/ non-HTTPS apps. Prevents checks failing for non-SSL sites"
},
"color": {
"title": "Custom Color",
"type": "string",
"description": "A custom fill color of the item, expressed either as hex code or color name"
},
"id": {
"title": "Item ID",
"type": "string",
"description": "Unique ID for each item. Generated automatically, shouldn't need to be set manually."
} }
} }
} }