matrix-org / matrix-org/matrix-spec

We should not require pusher URLs to be on a specific path

Open
#677 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

per matrix-org/matrix-doc#1522, pusher URLs "MUST ... have a path of /_matrix/push/v1/notify".

I believe this was added so that we had a way of upgrading the Push API: if we needed to introduce a v2, the homeserver would figure out if it needed to talk v1 or v2 by inspecting the URI.

However, I think this is a poor way of achieving that. It would make more sense to introduce a new pusher kind of http_v2 (to sit alongside the existing http and email).

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

Start by reviewing the pusher URL requirement in matrix-org/matrix-doc#1522 and the current pusher kind definitions in the Matrix specification. Trace all specification text affected by removing the fixed path and introducing http_v2; done means the versioning behavior and compatibility rules are specified consistently.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.