From 0277ac5ee845855be840cfcc05cdd93453efd637 Mon Sep 17 00:00:00 2001 From: CodeShell <122738806+CodeShellDev@users.noreply.github.com> Date: Sat, 1 Nov 2025 15:55:13 +0100 Subject: [PATCH] quote blocked endpoints --- .github/templates/README.template.md | 11 +++++++---- docs/configuration/endpoints.md | 11 +++++++---- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/.github/templates/README.template.md b/.github/templates/README.template.md index 5be88a5a..c1a1cc54 100644 --- a/.github/templates/README.template.md +++ b/.github/templates/README.template.md @@ -236,15 +236,18 @@ You can modify endpoints by configuring `access.endpoints` in your config: settings: access: endpoints: - - !/v1/register - - !/v1/unregister - - !/v1/qrcodelink - - !/v1/contacts + - "!/v1/register" + - "!/v1/unregister" + - "!/v1/qrcodelink" + - "!/v1/contacts" - /v2/send ``` By default adding an endpoint explictly allows access to it, use `!` to block it instead. +> [!IMPORTANT] +> When using `!` to block you must enclose the endpoint with quotes, like in the example above. + | Config (Allow) | (Block) | Result | | | | | :------------- | :------------- | :--------: | --- | :---------------: | --- | | `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ | diff --git a/docs/configuration/endpoints.md b/docs/configuration/endpoints.md index ee893b40..d0c05493 100644 --- a/docs/configuration/endpoints.md +++ b/docs/configuration/endpoints.md @@ -29,15 +29,18 @@ You can modify endpoints by configuring `access.endpoints` in your config: settings: access: endpoints: - - !/v1/register - - !/v1/unregister - - !/v1/qrcodelink - - !/v1/contacts + - "!/v1/register" + - "!/v1/unregister" + - "!/v1/qrcodelink" + - "!/v1/contacts" - /v2/send ``` By default adding an endpoint explictly allows access to it, use `!` to block it instead. +> [!IMPORTANT] +> When using `!` to block you must enclose the endpoint in quotes, like in the example above + | Config (Allow) | (Block) | Result | | | | | :------------- | :------------- | :--------: | --- | :---------------: | --- | | `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |