Merge pull request #1569 from turt2live/travis/c2s/user-directory

Clarify the homeserver's behaviour for user searching
pull/1573/head
Travis Ralston 6 years ago committed by GitHub
commit 73736d41db
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -31,8 +31,16 @@ paths:
post: post:
summary: Searches the user directory. summary: Searches the user directory.
description: |- description: |-
This API performs a server-side search over all users registered on the server. Performs a search for users on the homeserver. The homeserver may
It searches user ID and displayname case-insensitively for users that you share a room with or that are in public rooms. determine which subset of users are searched, however the homeserver
MUST at a minimum consider the users the requesting user shares a
room with and those who reside in public rooms (known to the homeserver).
The search MUST consider local users to the homeserver, and SHOULD
query remote users as part of the search.
The search is performed case-insensitively on user IDs and display
names preferably using a collation determined based upon the
``Accept-Language`` header provided in the request, if present.
operationId: searchUserDirectory operationId: searchUserDirectory
security: security:
- accessToken: [] - accessToken: []
@ -48,7 +56,7 @@ paths:
example: "foo" example: "foo"
limit: limit:
type: integer type: integer
description: The maximum number of results to return (Defaults to 10). description: The maximum number of results to return. Defaults to 10.
example: 10 example: 10
required: ["search_term"] required: ["search_term"]
responses: responses:

@ -0,0 +1 @@
Clarify the homeserver's behaviour for searching users.
Loading…
Cancel
Save