matrix-org / matrix-org/matrix-spec

Add ability to find or filter messages by date and author in /search API

Open
#251 3 comments 26 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Very often we need to find specific messages by date range, for example - in previous week. Seems at now there are no ability to find or filter messages by date and author in Matrix Server Side Search API: https://matrix.org/docs/spec/client_server/r0.2.0.html#id60
Also will be useful to filter messages by author.

Please add ability to filter search results by date range and author, and make search_term not mandatory field in search (for find all messages in date range).

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

Start with the /search API and the Matrix Client-Server API r0.2.0 section linked in the issue. Define how date ranges and author filters work, including searches with no search_term, then update the specification and its examples so the new request and response behavior is unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend-api-design, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.