Skip to content

Commit 624cf6b

Browse files
committed
docs(hosting): address review feedback on rate limiter defaults
- Reference the core config as a repo path instead of a PHP-style namespace with backslashes - Drop trailing periods from the Protects table cells per the docs table guidelines - Use shopware.yml consistently in the override example
1 parent a3e105b commit 624cf6b

1 file changed

Lines changed: 16 additions & 16 deletions

File tree

guides/hosting/infrastructure/rate-limiter.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -19,24 +19,24 @@ These rate limiters are always active. You do not need to add the `shopware.api.
1919

2020
## Default rate limiters
2121

22-
The following limiters are enabled by default. The values listed here reflect the current Shopware core configuration and may change between versions. When in doubt, the source of truth is `Shopware\Core\Framework\Resources\config\packages\shopware.yaml` in the version you are running.
22+
The following limiters are enabled by default. The values listed here reflect the current Shopware core configuration and may change between versions. When in doubt, the source of truth is `src/Core/Framework/Resources/config/packages/shopware.yaml` in the version you are running.
2323

2424
| Limiter | Protects | Since | Policy | Reset | Limits |
2525
| --- | --- | --- | --- | --- | --- |
26-
| `login` | Storefront / Store-API customer authentication. | 6.4.6.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
27-
| `guest_login` | Storefront / Store-API after-order guest authentication. | 6.4.6.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
28-
| `oauth` | API OAuth authentication / Administration login. | 6.4.6.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
29-
| `reset_password` | Storefront / Store-API customer password reset. | 6.4.6.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
30-
| `user_recovery` | Administration user password recovery. | 6.4.6.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
31-
| `contact_form` | Storefront / Store-API contact form. | 6.4.6.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
32-
| `notification` | Store-API notification endpoint. | 6.4.8.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
33-
| `newsletter_form` | Store-API newsletter registration. | 6.4.16.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
34-
| `cart_add_line_item` | Adding line items to the cart. | 6.4.18.0 | `system_config` | 1 hour | Limit read from `core.cart.lineItemAddLimit`, interval 60s |
35-
| `revocation_request_form` | Store-API revocation request form. | 6.7.9.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
36-
| `newsletter_unsubscribe_form` | Store-API newsletter unsubscribe. | 6.7.9.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
37-
| `app_shop_verify` | App shop registration verification. | 6.7.9.0 | `sliding_window` | n/a | 60 / 60min |
38-
| `mcp_admin_api` | MCP server Admin API access (keyed per OAuth token). | 6.8.0.0 | `time_backoff` | 1 hour | 300 / 60s, 1000 / 10min |
39-
| `mcp_store_api` | MCP server Store API access (keyed per sales-channel context token). | 6.8.0.0 | `time_backoff` | 1 hour | 120 / 60s, 600 / 10min |
26+
| `login` | Storefront / Store-API customer authentication | 6.4.6.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
27+
| `guest_login` | Storefront / Store-API after-order guest authentication | 6.4.6.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
28+
| `oauth` | API OAuth authentication / Administration login | 6.4.6.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
29+
| `reset_password` | Storefront / Store-API customer password reset | 6.4.6.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
30+
| `user_recovery` | Administration user password recovery | 6.4.6.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
31+
| `contact_form` | Storefront / Store-API contact form | 6.4.6.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
32+
| `notification` | Store-API notification endpoint | 6.4.8.0 | `time_backoff` | 24 hours | 10 / 10s, 15 / 30s, 20 / 60s |
33+
| `newsletter_form` | Store-API newsletter registration | 6.4.16.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
34+
| `cart_add_line_item` | Adding line items to the cart | 6.4.18.0 | `system_config` | 1 hour | Limit read from `core.cart.lineItemAddLimit`, interval 60s |
35+
| `revocation_request_form` | Store-API revocation request form | 6.7.9.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
36+
| `newsletter_unsubscribe_form` | Store-API newsletter unsubscribe | 6.7.9.0 | `time_backoff` | 24 hours | 3 / 30s, 5 / 60s, 10 / 90s |
37+
| `app_shop_verify` | App shop registration verification | 6.7.9.0 | `sliding_window` | n/a | 60 / 60min |
38+
| `mcp_admin_api` | MCP server Admin API access (keyed per OAuth token) | 6.8.0.0 | `time_backoff` | 1 hour | 300 / 60s, 1000 / 10min |
39+
| `mcp_store_api` | MCP server Store API access (keyed per sales-channel context token) | 6.8.0.0 | `time_backoff` | 1 hour | 120 / 60s, 600 / 10min |
4040

4141
In the table above, `Limits` uses the `limit / interval` notation, and `s` / `min` are seconds / minutes. When you add a new default limiter to the core, add a row here with its introduction version so this table stays complete.
4242

@@ -56,7 +56,7 @@ To override the [default rate limiters](#default-rate-limiters) for your shop, y
5656
The following example disables the `login` limiter and overrides the `oauth` limiter:
5757

5858
```yaml
59-
// <shop root>/config/packages/shopware.yaml
59+
// <shop root>/config/packages/shopware.yml
6060
shopware:
6161
api:
6262
rate_limiter:

0 commit comments

Comments
 (0)