Clarify that /context always returns 'event' even if limit is zero (#1239)
Signed-off-by: Sumner Evans <me@sumnerevans.com>
This commit is contained in:
parent
3f3b5c39f0
commit
84fbb611db
2 changed files with 5 additions and 1 deletions
|
@ -0,0 +1 @@
|
||||||
|
Clarify that `/context` always returns `event` even if `limit` is zero. Contributed by @sumnerevans at @beeper.
|
|
@ -57,7 +57,10 @@ paths:
|
||||||
type: integer
|
type: integer
|
||||||
name: limit
|
name: limit
|
||||||
description: |-
|
description: |-
|
||||||
The maximum number of events to return. Default: 10.
|
The maximum number of context events to return. The limit applies
|
||||||
|
to the sum of the `events_before` and `events_after` arrays. The
|
||||||
|
requested event ID is always returned in `event` even if `limit` is
|
||||||
|
0. Defaults to 10.
|
||||||
x-example: 3
|
x-example: 3
|
||||||
- in: query
|
- in: query
|
||||||
name: filter
|
name: filter
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue