matrix-org / matrix-org/matrix-spec

Unspecced default filter behaviour

Open
#663 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Client-Server clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

It appears that Synapse will, if no filter is specified on a `/sync` request, default to some sort of internal filter with a limit of 10 events per room timeline.

The spec, however, *implies* that `limited` will only be `true` if a filter is specified, through the following passage:

> True if the number of events returned was limited by the `limit` on the filter.

... but never explicitly says whether not specifying a `filter` should mean that there is no limit, or some sort of default limit.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the `/sync` filter and `limited` wording in the Matrix specification, then compare it with the issue’s reported default behavior when no filter is supplied. The issue does not identify a file or test; first determine what behavior the specification should define. Done means the specification clearly states whether an omitted filter imposes a timeline limit and how `limited` is reported.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.