From 402ca51b562318c5f812cea67a3fe08c6671577d Mon Sep 17 00:00:00 2001 From: Sumner Evans Date: Tue, 22 Nov 2022 12:08:46 -0500 Subject: [PATCH] Clarify that /context always returns 'event' even if limit is zero (#1239) Signed-off-by: Sumner Evans --- changelogs/client_server/newsfragments/1239.clarification | 1 + data/api/client-server/event_context.yaml | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 changelogs/client_server/newsfragments/1239.clarification diff --git a/changelogs/client_server/newsfragments/1239.clarification b/changelogs/client_server/newsfragments/1239.clarification new file mode 100644 index 000000000..f2c403d1a --- /dev/null +++ b/changelogs/client_server/newsfragments/1239.clarification @@ -0,0 +1 @@ +Clarify that `/context` always returns `event` even if `limit` is zero. Contributed by @sumnerevans at @beeper. diff --git a/data/api/client-server/event_context.yaml b/data/api/client-server/event_context.yaml index cf3476b09..4a2541a6d 100644 --- a/data/api/client-server/event_context.yaml +++ b/data/api/client-server/event_context.yaml @@ -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