Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-20 16:38:37 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #224 from matrix-org/markjh/filter_inline

Browse source 
Allow the filter JSON to be passed inline in the /sync request
This commit is contained in:
Mark Haines 2015-12-09 11:53:43 +00:00
parent f22adad02e c3a1318886
commit a33e49fd1e
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
api/client-server/sync.yaml
View file

@ -32,7 +32,13 @@ paths:
name: filter name: filter
type: string type: string
description: |- description: |-
The ID of a filter created using the filter API. The ID of a filter created using the filter API or a filter JSON
object enocoded as a string. The server will detect whether it is
an ID or a JSON object by whether the first character is a ``"{"``
open brace. Passing the JSON inline is best suited to one off
requests. Creating a filter using the filter API is recommended for
clients that reuse the same filter multiple times, for example in
long poll requests.
x-example: "66696p746572" x-example: "66696p746572"
- in: query - in: query
name: since name: since