matrix-org / matrix-org/matrix-spec
Suggestion: Hash filter contents as the filterId (or add a filterAlias property)
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
**Suggestion**
Filters created via `POST /_matrix/client/v3/user/{userId}/filter` are difficult to manage because their resulting ID is generated dynamically on upload from the client. This forces clients to use computed IDs obtained by uploading each filter's full JSON definition to the home-server on startup. By switching to hashes, filter IDs could be computed independently and referenced statically in config files. Moreover, this lays the groundwork for a separate service that fresh clients can use to verify filters exist before sending full JSON definition.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Matrix Client-Server API endpoint POST /_matrix/client/v3/user/{userId}/filter and its filter ID behavior. Determine whether deterministic content hashes or a filterAlias is the intended direction, and define how clients can reference filters without uploading the full JSON definition.
Written by the indexing model from the issue text.
Assessment
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100