diff --git a/api/client-server/filter.yaml b/api/client-server/filter.yaml index 3350135f..e8ef3e70 100644 --- a/api/client-server/filter.yaml +++ b/api/client-server/filter.yaml @@ -22,8 +22,8 @@ paths: summary: Upload a new filter. description: |- Uploads a new filter definition to the homeserver. - Returns a filter ID that may be used in /sync requests to - retrict which events are returned to the client. + Returns a filter ID that may be used in future requests to + restrict which events are returned to the client. security: - accessToken: [] parameters: diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index 8def2ae1..ef727ec2 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -569,6 +569,15 @@ Where $streamtoken is an opaque token which can be used in another query to get the next set of results. The "start" and "end" keys can only be omitted if the complete dataset is provided in "chunk". +Filtering +--------- + +Filters can be created on the server and can be passed as as a parameter to APIs +which return events. These filters alter the data returned from those APIs. +Not all APIs accept filters. + +{{filter_http_api}} + Events ------