wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Make it explicit that the JSON filter object is passed as a string

Browse source
This commit is contained in:
Mark Haines 2015-12-09 10:50:02 +00:00
parent ed70bcb180
commit c3a1318886
1 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -33,11 +33,12 @@ paths:
type: string
description: |-
The ID of a filter created using the filter API or a filter JSON
object. 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.
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"
- in: query
name: since