matrix-org / matrix-org/matrix-spec

The search endpoint does not mention the list of allowed values for `room_events.keys`

Open
#1,173 4 comments 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

**Link to problem area**: https://spec.matrix.org/v1.3/client-server-api/#post_matrixclientv3search

**Issue**

The documentation for the `room_events.keys` parameter does not mention a restricted list of keys to use for search, implying (as per my own interpretation) that all keys in an event are searchable. However, since https://github.com/matrix-org/synapse/pull/307 (which predates the spec for this endpoint) Synapse has always restricted this list to `["content.body", "content.name", "content.topic"]`.

**Expected behaviour**

The spec should mention that the values for `room_events.keys` must be included in `["content.body", "content.name", "content.topic"]`.

Contributor guide

Open the contributing guide

Research direction

Open the linked Matrix Client-Server API search section for POST /_matrix/client/v3/search and inspect the room_events.keys parameter description. Update the specification to state the allowed values listed in the issue, then verify that the parameter documentation no longer implies arbitrary event keys are searchable.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.