Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 6e4f71c

Browse files
authored
Fix a buglet in the SAML username mapping provider doc (#8873)
the constructor is called with a `module_api`.
1 parent cf3b815 commit 6e4f71c

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

changelog.d/8873.doc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix an error in the documentation for the SAML username mapping provider.

docs/sso_mapping_providers.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,13 @@ comment these options out and use those specified by the module instead.
116116

117117
A custom mapping provider must specify the following methods:
118118

119-
* `__init__(self, parsed_config)`
119+
* `__init__(self, parsed_config, module_api)`
120120
- Arguments:
121121
- `parsed_config` - A configuration object that is the return value of the
122122
`parse_config` method. You should set any configuration options needed by
123123
the module here.
124+
- `module_api` - a `synapse.module_api.ModuleApi` object which provides the
125+
stable API available for extension modules.
124126
* `parse_config(config)`
125127
- This method should have the `@staticmethod` decoration.
126128
- Arguments:

0 commit comments

Comments
 (0)