From d1c96ee0f22e5e199eedff96914eda04822a7e35 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Tue, 30 Sep 2025 22:17:11 +0200 Subject: [PATCH] Fix `rc_room_creation` and `rc_reports` docs - remove `per_user` typo (#18998) --- changelog.d/18998.doc | 1 + docs/usage/configuration/config_documentation.md | 10 ++++------ schema/synapse-config.schema.yaml | 10 ++++------ 3 files changed, 9 insertions(+), 12 deletions(-) create mode 100644 changelog.d/18998.doc diff --git a/changelog.d/18998.doc b/changelog.d/18998.doc new file mode 100644 index 000000000..9ddc2d41c --- /dev/null +++ b/changelog.d/18998.doc @@ -0,0 +1 @@ +Fix documentation for `rc_room_creation` and `rc_reports` to clarify that a `per_user` rate limit is not supported. diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 3c401d569..7bcf82e7a 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -2006,9 +2006,8 @@ This setting has the following sub-options: Default configuration: ```yaml rc_reports: - per_user: - per_second: 1.0 - burst_count: 5.0 + per_second: 1.0 + burst_count: 5.0 ``` Example configuration: @@ -2031,9 +2030,8 @@ This setting has the following sub-options: Default configuration: ```yaml rc_room_creation: - per_user: - per_second: 0.016 - burst_count: 10.0 + per_second: 0.016 + burst_count: 10.0 ``` Example configuration: diff --git a/schema/synapse-config.schema.yaml b/schema/synapse-config.schema.yaml index 2a7f94a70..b406af040 100644 --- a/schema/synapse-config.schema.yaml +++ b/schema/synapse-config.schema.yaml @@ -2259,9 +2259,8 @@ properties: Setting this to a high value allows users to report content quickly, possibly in duplicate. This can result in higher database usage. default: - per_user: - per_second: 1.0 - burst_count: 5.0 + per_second: 1.0 + burst_count: 5.0 examples: - per_second: 2.0 burst_count: 20.0 @@ -2270,9 +2269,8 @@ properties: description: >- Sets rate limits for how often users are able to create rooms. default: - per_user: - per_second: 0.016 - burst_count: 10.0 + per_second: 0.016 + burst_count: 10.0 examples: - per_second: 1.0 burst_count: 5.0