Backwards incompatibility warning for ThirdPartyEventRules in UPGRADE.rst

pull/8292/head
Andrew Morgan 2020-09-14 15:31:16 +01:00
parent 04ab21ca5f
commit 06deecfe84
1 changed files with 11 additions and 0 deletions

View File

@ -127,6 +127,17 @@ request to
with the query parameters from the original link, presented as a URL-encoded form. See the file
itself for more details.
ThirdPartyEventRules breaking changes
-------------------------------------
This release introduces a backwards-incompatible change to modules making use of
`ThirdPartyEventRules` in Synapse.
The `http_client` argument is no longer passed to modules as they are initialised. Instead,
modules are expected to make use of the `http_client` property on the `ModuleApi` class.
Modules are now passed a `module_api` argument during initialisation, which is an instance of
`ModuleApi`.
Upgrading to v1.18.0
====================