matrix-org / matrix-org/matrix-spec

StateFilter and RoomEventFilter for filter API are duplicates

Open
#598 1 comment 0 reactions 0 assignees View on GitHub
A-Client-Server clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

In the [filter API](https://matrix.org/docs/spec/client_server/r0.6.0#post-matrix-client-r0-user-userid-filter), the `StateFilter` and `RoomEventFilter` types seem to have an exactly identical definition.

Is this intentional (eg. to denote a future semantic difference) or a bug? And if it is intentional, shouldn't it include a note that the two are currently the same, so that an implementer doesn't need to read both and (expect to) spot the differences?

Contributor guide

Open the contributing guide

Research direction

Start with the linked filter API section in the Matrix client-server specification and compare the definitions of StateFilter and RoomEventFilter. Determine whether their identical definitions are intentional; done means either documenting the equivalence clearly or recording the confirmed distinction in the specification.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.