From 7cc4b26e3416102d3e5d6032855edd68d8a4894f Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Fri, 28 Jan 2022 23:25:47 +0000 Subject: [PATCH] :card_file_box: Updates schema and config docs (#456) --- docs/configuring.md | 1 + src/utils/ConfigSchema.json | 8 +++++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/configuring.md b/docs/configuring.md index 5f5517a0..64b5028b 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -193,6 +193,7 @@ For more info, see the **[Authentication Docs](/docs/authentication.md)** **`statusCheckUrl`** | `string` | _Optional_ | If you've enabled `statusCheck`, and want to use a different URL to what is defined under the item, then specify it here **`statusCheckHeaders`** | `object` | _Optional_ | If you're endpoint requires any specific headers for the status checking, then define them here **`statusCheckAllowInsecure`** | `boolean` | _Optional_ | By default, any request to insecure content will be blocked. Setting this option to `true` will disable the `rejectUnauthorized` option, enabling you to ping non-HTTPS services for the current item. Defaults to `false` +**`statusCheckAcceptCodes`** | `string` | _Optional_ | If your service's response code is anything other than 2xx, then you can opt to specify an alternative success code. E.g. if you expect your server to return 403, but still want the status indicator to be green, set this value to `403` **`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well **`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background **`provider`** | `string` | _Optional_ | The name of the provider for a given service, useful for when including hosted apps. In some themes, this is visible under the item name diff --git a/src/utils/ConfigSchema.json b/src/utils/ConfigSchema.json index f3aaa3e6..abfe51cf 100644 --- a/src/utils/ConfigSchema.json +++ b/src/utils/ConfigSchema.json @@ -758,6 +758,12 @@ "default": false, "description": "Allows for running status checks on insecure content/ non-HTTPS apps. Prevents checks failing for non-SSL sites" }, + "statusCheckAcceptCodes": { + "title": "Accepted HTTP Status Codes", + "type": "string", + "default": "", + "description": "If your service's response code is anything other than 2xx, then you can opt to specify an alternative success code" + }, "color": { "title": "Custom Color", "type": "string", @@ -796,4 +802,4 @@ } } } -} \ No newline at end of file +}