Skip to content

Commit 3353f4a

Browse files
authored
docs: quote blocked endpoints (#112)
1 parent be59215 commit 3353f4a

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

.github/templates/README.template.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -236,15 +236,18 @@ You can modify endpoints by configuring `access.endpoints` in your config:
236236
settings:
237237
access:
238238
endpoints:
239-
- !/v1/register
240-
- !/v1/unregister
241-
- !/v1/qrcodelink
242-
- !/v1/contacts
239+
- "!/v1/register"
240+
- "!/v1/unregister"
241+
- "!/v1/qrcodelink"
242+
- "!/v1/contacts"
243243
- /v2/send
244244
```
245245

246246
By default adding an endpoint explictly allows access to it, use `!` to block it instead.
247247

248+
> [!IMPORTANT]
249+
> When using `!` to block you must enclose the endpoint with quotes, like in the example above.
250+
248251
| Config (Allow) | (Block) | Result | | | |
249252
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
250253
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |

docs/configuration/endpoints.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,18 @@ You can modify endpoints by configuring `access.endpoints` in your config:
2929
settings:
3030
access:
3131
endpoints:
32-
- !/v1/register
33-
- !/v1/unregister
34-
- !/v1/qrcodelink
35-
- !/v1/contacts
32+
- "!/v1/register"
33+
- "!/v1/unregister"
34+
- "!/v1/qrcodelink"
35+
- "!/v1/contacts"
3636
- /v2/send
3737
```
3838
3939
By default adding an endpoint explictly allows access to it, use `!` to block it instead.
4040

41+
> [!IMPORTANT]
42+
> When using `!` to block you must enclose the endpoint in quotes, like in the example above
43+
4144
| Config (Allow) | (Block) | Result | | | |
4245
| :------------- | :------------- | :--------: | --- | :---------------: | --- |
4346
| `/v2/send` | `unset` | **all** | 🛑 | **`/v2/send`** | ✅ |

0 commit comments

Comments
 (0)