Clarify that /context always returns 'event' even if limit is zero #1239
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sumner Evans <me@sumnerevans.com>
Signed-off-by: Sumner Evans <me@sumnerevans.com>
turt2live
reviewed
Sep 21, 2022
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Co-authored-by: Travis Ralston <travpc@gmail.com>
richvdh
approved these changes
Nov 22, 2022
This was referenced Dec 14, 2022
clokep
pushed a commit
to clokep/matrix-spec
that referenced
this pull request
May 3, 2023
…atrix-org#1239) Signed-off-by: Sumner Evans <me@sumnerevans.com>
11 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Sumner Evans me@sumnerevans.com
name: Clarify that /context always returns 'event' even if limit is zero
about: The spec is not clear that the limit does not apply to the event itself.
title: ''
labels: ''
assignees: ''
Pull Request Checklist
Preview: https://pr1239--matrix-spec-previews.netlify.app