Skip to content

Commit 1ab35a0

Browse files
Mark new module APIs as experimental (#18536)
1 parent 341d956 commit 1ab35a0

File tree

4 files changed

+21
-0
lines changed

4 files changed

+21
-0
lines changed

changelog.d/18536.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Mark the new module APIs in this release as experimental.

docs/modules/media_repository_callbacks.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ _First introduced in Synapse v1.132.0_
1414
async def get_media_config_for_user(user_id: str) -> Optional[JsonDict]
1515
```
1616

17+
**<span style="color:red">
18+
Caution: This callback is currently experimental . The method signature or behaviour
19+
may change without notice.
20+
</span>**
21+
1722
Called when processing a request from a client for the
1823
[media config endpoint](https://spec.matrix.org/latest/client-server-api/#get_matrixclientv1mediaconfig).
1924

@@ -39,6 +44,11 @@ _First introduced in Synapse v1.132.0_
3944
async def is_user_allowed_to_upload_media_of_size(user_id: str, size: int) -> bool
4045
```
4146

47+
**<span style="color:red">
48+
Caution: This callback is currently experimental . The method signature or behaviour
49+
may change without notice.
50+
</span>**
51+
4252
Called before media is accepted for upload from a user, in case the module needs to
4353
enforce a different limit for the particular user.
4454

docs/modules/ratelimit_callbacks.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@ _First introduced in Synapse v1.132.0_
1414
async def get_ratelimit_override_for_user(user: str, limiter_name: str) -> Optional[synapse.module_api.RatelimitOverride]
1515
```
1616

17+
**<span style="color:red">
18+
Caution: This callback is currently experimental . The method signature or behaviour
19+
may change without notice.
20+
</span>**
21+
1722
Called when constructing a ratelimiter of a particular type for a user. The module can
1823
return a `messages_per_second` and `burst_count` to be used, or `None` if
1924
the default settings are adequate. The user is represented by their Matrix user ID

docs/modules/spam_checker_callbacks.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,11 @@ _First introduced in Synapse v1.132.0_
254254
async def user_may_send_state_event(user_id: str, room_id: str, event_type: str, state_key: str, content: JsonDict) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"]
255255
```
256256

257+
**<span style="color:red">
258+
Caution: This callback is currently experimental . The method signature or behaviour
259+
may change without notice.
260+
</span>**
261+
257262
Called when processing a request to [send state events](https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3roomsroomidstateeventtypestatekey) to a room.
258263

259264
The arguments passed to this callback are:

0 commit comments

Comments
 (0)