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

markjh/filter_inline
Mark Haines 9 years ago
parent ed70bcb180
commit c3a1318886

@ -33,11 +33,12 @@ paths:
type: string type: string
description: |- description: |-
The ID of a filter created using the filter API or a filter JSON 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 object enocoded as a string. The server will detect whether it is
by whether the first character is a ``"{"`` open brace. Passing the an ID or a JSON object by whether the first character is a ``"{"``
JSON inline is best suited to one off requests. Creating a filter open brace. Passing the JSON inline is best suited to one off
using the filter API is recommended for clients that reuse the same requests. Creating a filter using the filter API is recommended for
filter multiple times, for example in long poll requests. 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

Loading…
Cancel
Save