diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2020-08-25 15:03:24 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-25 15:03:24 +0100 |
| commit | 74bf8d4d0659a87152804dc56df9284be87512bb (patch) | |
| tree | dc3bcf29935838f49890e4d96a47c26304bc60d6 /docs | |
| parent | Fix missing double-backtick in RST document (diff) | |
| download | synapse-74bf8d4d0659a87152804dc56df9284be87512bb.tar.xz | |
Wording fixes to 'name' user admin api filter (#8163)
Some fixes to wording I noticed after merging #7377.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_api/user_admin_api.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/admin_api/user_admin_api.rst b/docs/admin_api/user_admin_api.rst index 9cb924895f..d6e3194cda 100644 --- a/docs/admin_api/user_admin_api.rst +++ b/docs/admin_api/user_admin_api.rst @@ -119,10 +119,11 @@ from a previous call. The parameter ``limit`` is optional but is used for pagination, denoting the maximum number of items to return in this call. Defaults to ``100``. -The parameter ``user_id`` is optional and can be used to filter by user id. +The parameter ``user_id`` is optional and filters to only return users with user IDs +that contain this value. This parameter is ignored when using the ``name`` parameter. -The parameter ``name`` is optional and can be used to list only users with the -local part of the user ID or display name that contain this value. +The parameter ``name`` is optional and filters to only return users with user ID localparts +**or** displaynames that contain this value. The parameter ``guests`` is optional and if ``false`` will **exclude** guest users. Defaults to ``true`` to include guest users. |