From 458258938d9bdee9063445efb63a925ff234eec9 Mon Sep 17 00:00:00 2001 From: Sumner Evans Date: Thu, 15 Sep 2022 22:33:46 -0600 Subject: [PATCH] Clarify that /context always returns 'event' even if limit is zero Signed-off-by: Sumner Evans --- data/api/client-server/event_context.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/data/api/client-server/event_context.yaml b/data/api/client-server/event_context.yaml index cf3476b0..659aea41 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. Default: 10. x-example: 3 - in: query name: filter