Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

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
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog.d/7377.misc
View File

@ -1 +1 @@
Search in columns 'name' and 'displayname' in the admin users endpoint. Contributed by Awesome Technologies Innovationslabor GmbH. Add filter `name` to the `/users` admin API, which filters by user ID or displayname. Contributed by Awesome Technologies Innovationslabor GmbH.

1
changelog.d/8163.misc Normal file
View File

@ -0,0 +1 @@
Add filter `name` to the `/users` admin API, which filters by user ID or displayname. Contributed by Awesome Technologies Innovationslabor GmbH.

7
docs/admin_api/user_admin_api.rst
View File

@ -119,10 +119,11 @@ from a previous call.
The parameter ``limit`` is optional but is used for pagination, denoting the The parameter ``limit`` is optional but is used for pagination, denoting the
maximum number of items to return in this call. Defaults to ``100``. 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 The parameter ``name`` is optional and filters to only return users with user ID localparts
local part of the user ID or display name that contain this value. **or** displaynames that contain this value.
The parameter ``guests`` is optional and if ``false`` will **exclude** guest users. The parameter ``guests`` is optional and if ``false`` will **exclude** guest users.
Defaults to ``true`` to include guest users. Defaults to ``true`` to include guest users.

2
synapse/storage/databases/main/__init__.py
View File

@ -507,7 +507,7 @@ class DataStore(
Args: Args:
start (int): start number to begin the query from start (int): start number to begin the query from
limit (int): number of rows to retrieve limit (int): number of rows to retrieve
user_id (string): search for user_id user_id (string): search for user_id. ignored if name is not None
name (string): search for local part of user_id or display name name (string): search for local part of user_id or display name
guests (bool): whether to in include guest users guests (bool): whether to in include guest users
deactivated (bool): whether to include deactivated users deactivated (bool): whether to include deactivated users