From ed70bcb180e20448ea12a8b6e8924a341eafdbc5 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Tue, 8 Dec 2015 14:36:50 +0000 Subject: [PATCH] Add a rationale for allowing both inline filters and passing filters by id. --- api/client-server/sync.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/api/client-server/sync.yaml b/api/client-server/sync.yaml index 7ce04c3f..239cce89 100644 --- a/api/client-server/sync.yaml +++ b/api/client-server/sync.yaml @@ -34,7 +34,10 @@ paths: 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. + 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