Skip to content

Clarify that /context always returns 'event' even if limit is zero #1239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
richvdh merged 3 commits into from
Nov 22, 2022
Merged

Clarify that /context always returns 'event' even if limit is zero #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4582589
Clarify that /context always returns 'event' even if limit is zero
sumnerevans Sep 16, 2022
f7bdf65
Add changelog
sumnerevans Sep 16, 2022
7c860ff
Apply suggestions from code review
richvdh Nov 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1239.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that `/context` always returns `event` even if `limit` is zero. Contributed by @sumnerevans at @beeper.
5 changes: 4 additions & 1 deletion data/api/client-server/event_context.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

@turt2live turt2live Sep 21, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there something to prove that this is true? It's generally sensible, though we do need evidence that this PR is a bug fix rather than a change.

Copy link
Member

@richvdh richvdh Nov 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's what synapse does: https://github.com/matrix-org/synapse/blob/v1.72.0/synapse/handlers/room.py#L1365-L1366

Let's just get this shipped.

requested event ID is always returned in `event` even if `limit` is
0. Defaults to 10.
x-example: 3
- in: query
name: filter
Expand Down