matrix-org / matrix-org/matrix-spec

Contradictory documentation of keys in /search API

Open
#463 3 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

The documentation for `keys` for the type "Room Events Criteria" under [the `/search` API](https://matrix.org/docs/spec/client_server/r0.4.0.html#post-matrix-client-r0-search) says this:

> The keys to search. Defaults to all. One of: `["content.body", "content.name", "content.topic"]`

However, the type of the property is `[enum]` (array) and the example is also an array containing one of the enum values.

Is it true that only one of the enum values can be supplied? And if so, why is it an array?

Contributor guide

Open the contributing guide

Research direction

Read the linked `/search` API section and the definition of the “Room Events Criteria” type. Determine whether `keys` accepts one or multiple enum values, then update the documentation so the prose, array type, and example agree; done means the contradiction is removed.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.