matrix-org / matrix-org/matrix-spec
"default" is poorly defined in PushRule response
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
[GET /_matrix/client/r0/pushrules](https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-pushrules) and others return a PushRule structure with a `default` field. It's unclear what this is set to if the rule is a default rule which has been modified by the user.
(empirically, synapse sets it to `true` in this case)
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 linked GET /_matrix/client/r0/pushrules specification and the PushRule structure, focusing on the meaning of its `default` field. Clarify how the field is defined when a default rule has been modified by the user, including whether the observed Synapse behavior is intended, and update the specification so the result is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100