dandri/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2026-05-14 21:15:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Wording fixes to 'name' user admin api filter (#8163)

Browse Source 
Some fixes to wording I noticed after merging #7377.
This commit is contained in:
Andrew Morgan
2020-08-25 15:03:24 +01:00
committed by GitHub
parent 79ac619403
commit 74bf8d4d06
4 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin_api/user_admin_api.rst
+4 -3
View File
@@ -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.