matrix-org / matrix-org/matrix-spec
Public room directory response should allow for extra fields
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
The public room directory response currently allows a [static set of keys](https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-publicrooms) for each room entry. It would be good to be able to extend this field-set optionally without having to go off spec, in the same way we allow events to be of any `type` and contain any `content`.
For instance, information from [MSC2346](https://github.com/matrix-org/matrix-doc/pulls/2346) could be included to announce bridges in public rooms. Being able to include arbitrary state would be useful. While this information would be impossible to verify, it's no worse than already trusting the avatar/topic/name.
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 with the public room directory response section linked in the issue and read MSC2346 for the proposed bridge information. Determine how optional arbitrary room fields should be represented and specified, then update the relevant Matrix specification text and examples so the extension is explicitly defined.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100