matrix-org / matrix-org/matrix-spec

AS spec doesn't state which events should be pushed under the "Pushing events" header

Open
#743 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-Application-Services clarification
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

https://matrix.org/docs/spec/application_service/r0.1.2#pushing-events explains *how* events should be pushed, but it does not define *which* events.

My take is that the section in https://matrix.org/docs/spec/application_service/r0.1.2#registration:

>An application service is said to be "interested" in a given event if one of the IDs in the event match the regular expression provided by the application service, such as the room having an alias or ID in the relevant namespaces. Similarly, the application service is said to be interested in a given event if one of the application service's namespaced users is the target of the event, or is a joined member of the room where the event occurred.

is the set of rules that define this, however it's not actually mentioned if this is the case for pushing. Perhaps the spec could clarify.

CC: @Kegsay

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

Read the linked "Pushing events" and "Registration" sections of the application service specification, focusing on how "interested" events are described. Clarify whether those rules define the events sent under "Pushing events," and update the specification so the relationship is explicit.

Written by the indexing model from the issue text.

Assessment

Domain
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.