Clarify that /context always returns 'event' even if limit is zero (m…

…atrix-org#1239) Signed-off-by: Sumner Evans <me@sumnerevans.com>
clokep · May 3, 2023 · 402ca51 · 402ca51
1 parent 049c9c4
commit 402ca51
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/changelogs/client_server/newsfragments/1239.clarification 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
@@ -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