matrix-org / matrix-org/matrix-spec

push api does not define a mechanism to indicate a push failed

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

Nobody has claimed this yet.

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

Description

According to https://matrix.org/docs/spec/push_gateway/r0.1.1#post-matrix-push-v1-notify, 200 is the only valid response code.

What if there was an error talking to the upstream notification system? What if the request was invalid? What if we were overloaded? What if the push failed some sort of security check?

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 reading the referenced Matrix Push Gateway r0.1.1 POST /_matrix/push/v1/notify specification section. Determine how upstream failures, invalid requests, overload, and security-check failures should be represented; the work is done when the specification defines an agreed response mechanism for these cases.

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
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.