Try to clarify the filter information on /context

This commit is contained in:
Travis Ralston 2019-11-05 16:08:15 -07:00
parent 021c056efc
commit e59bb20dc3

View file

@ -63,10 +63,9 @@ paths:
name: filter
type: string
description: |-
The ID of a filter created using the filter API or a filter JSON
object encoded 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.
A JSON ``RoomEventFilter`` to filter the returned events with. The
filter can be applied before or/and after the ``limit`` parameter -
whichever the homeserver prefers.
See `Filtering <#filtering>`_ for more information.
x-example: "66696p746572"