mirror of
https://github.com/element-hq/synapse
synced 2024-10-05 15:22:41 +00:00
Fix a buglet in the SAML username mapping provider doc (#8873)
the constructor is called with a `module_api`.
This commit is contained in:
parent
cf3b8156be
commit
6e4f71c057
2 changed files with 4 additions and 1 deletions
1
changelog.d/8873.doc
Normal file
1
changelog.d/8873.doc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Fix an error in the documentation for the SAML username mapping provider.
|
|
@ -116,11 +116,13 @@ comment these options out and use those specified by the module instead.
|
||||||
|
|
||||||
A custom mapping provider must specify the following methods:
|
A custom mapping provider must specify the following methods:
|
||||||
|
|
||||||
* `__init__(self, parsed_config)`
|
* `__init__(self, parsed_config, module_api)`
|
||||||
- Arguments:
|
- Arguments:
|
||||||
- `parsed_config` - A configuration object that is the return value of the
|
- `parsed_config` - A configuration object that is the return value of the
|
||||||
`parse_config` method. You should set any configuration options needed by
|
`parse_config` method. You should set any configuration options needed by
|
||||||
the module here.
|
the module here.
|
||||||
|
- `module_api` - a `synapse.module_api.ModuleApi` object which provides the
|
||||||
|
stable API available for extension modules.
|
||||||
* `parse_config(config)`
|
* `parse_config(config)`
|
||||||
- This method should have the `@staticmethod` decoration.
|
- This method should have the `@staticmethod` decoration.
|
||||||
- Arguments:
|
- Arguments:
|
||||||
|
|
Loading…
Reference in a new issue