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:
Sumner Evans 2022-11-22 12:08:46 -05:00 committed by GitHub
parent 3f3b5c39f0
commit 84fbb611db
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions

View file

@ -0,0 +1 @@
Clarify that `/context` always returns `event` even if `limit` is zero. Contributed by @sumnerevans at @beeper.

View file

@ -57,7 +57,10 @@ paths:
type: integer
name: limit
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
- in: query
name: filter