From f3a346d91c151b599db22300665083d9e285e436 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20=C5=81oskot?= Date: Wed, 14 May 2025 01:07:38 +0200 Subject: [PATCH] docs: Update list of characters sanitised in endpoint key (#1099) The hash was missing. Co-authored-by: TwiN --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bf9704ef..d2621c7d 100644 --- a/README.md +++ b/README.md @@ -322,7 +322,7 @@ To push the status of an external endpoint, the request would have to look like POST /api/v1/endpoints/{key}/external?success={success}&error={error} ``` Where: -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. - Using the example configuration above, the key would be `core_ext-ep-test`. - `{success}` is a boolean (`true` or `false`) value indicating whether the health check was successful or not. - `{error}`: a string describing the reason for a failed health check. If {success} is false, this should contain the error message; if the check is successful, it can be omitted or left empty. @@ -2375,7 +2375,7 @@ The path to generate a badge is the following: ``` Where: - `{duration}` is `30d`, `7d`, `24h` or `1h` -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. For instance, if you want the uptime during the last 24 hours from the endpoint `frontend` in the group `core`, the URL would look like this: @@ -2401,7 +2401,7 @@ The path to generate a badge is the following: /api/v1/endpoints/{key}/health/badge.svg ``` Where: -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. For instance, if you want the current status of the endpoint `frontend` in the group `core`, the URL would look like this: @@ -2418,7 +2418,7 @@ The path to generate a badge is the following: /api/v1/endpoints/{key}/health/badge.shields ``` Where: -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. For instance, if you want the current status of the endpoint `frontend` in the group `core`, the URL would look like this: @@ -2441,7 +2441,7 @@ The endpoint to generate a badge is the following: ``` Where: - `{duration}` is `30d`, `7d`, `24h` or `1h` -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. #### Response time (chart) ![Response time 24h](https://status.twin.sh/api/v1/endpoints/core_blog-external/response-times/24h/chart.svg) @@ -2454,7 +2454,7 @@ The endpoint to generate a response time chart is the following: ``` Where: - `{duration}` is `30d`, `7d`, or `24h` -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. ##### How to change the color thresholds of the response time badge To change the response time badges' threshold, a corresponding configuration can be added to an endpoint. @@ -2507,7 +2507,7 @@ The path to get raw uptime data for an endpoint is: ``` Where: - `{duration}` is `30d`, `7d`, `24h` or `1h` -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. For instance, if you want the raw uptime data for the last 24 hours from the endpoint `frontend` in the group `core`, the URL would look like this: ``` @@ -2521,7 +2521,7 @@ The path to get raw response time data for an endpoint is: ``` Where: - `{duration}` is `30d`, `7d`, `24h` or `1h` -- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`. +- `{key}` has the pattern `_` in which both variables have ` `, `/`, `_`, `,`, `.` and `#` replaced by `-`. For instance, if you want the raw response time data for the last 24 hours from the endpoint `frontend` in the group `core`, the URL would look like this: ```