changes based on Pull Request feedback

pull/977/head
Michael Telatynski 7 years ago
parent 3d8fe6e090
commit 784adade9b
No known key found for this signature in database
GPG Key ID: 3F879DA5AD802A5E

@ -32,8 +32,8 @@ paths:
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. This API performs a server-side search over all users registered on the server.
Searches MXID and displayname case-insesitively for users that you share a room with or that are in public rooms. It searches user ID and displayname case-insensitively for users that you share a room with or that are in public rooms.
operationId: postUserDirectorySearch operationId: searchUserDirectory
security: security:
- accessToken: [] - accessToken: []
parameters: parameters:
@ -48,7 +48,7 @@ paths:
example: "foo" example: "foo"
limit: limit:
type: number type: number
description: The maximum number of results to return (10 if omitted), with a maximum of 50 description: The maximum number of results to return (Defaults to 10).
example: 10 example: 10
required: ["search_term"] required: ["search_term"]
responses: responses:
@ -80,7 +80,7 @@ paths:
user_id: user_id:
type: string type: string
example: "@foo:bar.com" example: "@foo:bar.com"
description: The MXID of the user. description: The user's matrix user ID.
display_name: display_name:
type: string type: string
example: "Foo" example: "Foo"

@ -1351,7 +1351,7 @@ Profiles
{{profile_cs_http_api}} {{profile_cs_http_api}}
Events on Change of Profile Information Events on Change of Profile Information
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +++++++++++++++++++++++++++++++++++++++
Because the profile display name and avatar information are likely to be used in Because the profile display name and avatar information are likely to be used in
many places of a client's display, changes to these fields cause an automatic many places of a client's display, changes to these fields cause an automatic
propagation event to occur, informing likely-interested parties of the new propagation event to occur, informing likely-interested parties of the new

Loading…
Cancel
Save