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

matrix-org · Dec 9, 2015 · c3a1318 · c3a1318
1 parent ed70bcb
commit c3a1318
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/api/client-server/sync.yaml b/api/client-server/sync.yaml
@@ -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