matrix-org / matrix-org/matrix-spec
Make `origin` field go away
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Updated by @richvdh 2023/05/30:
`origin` is specced but redundant in:
* [`transaction`](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv1sendtxnid)
* the body of a [`/backfill`](https://spec.matrix.org/v1.7/server-server-api/#get_matrixfederationv1backfillroomid) response.
* the body of [`/make_join`](https://spec.matrix.org/v1.7/server-server-api/#get_matrixfederationv1make_joinroomiduserid) responses.
* the body of [v1](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv1send_joinroomideventid) and [v2](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv2send_joinroomideventid) `/send_join` requests.
* the body of [`/make_knock`](https://spec.matrix.org/v1.7/server-server-api/#get_matrixfederationv1make_knockroomiduserid) responses.
* the body of [`/make_leave`](https://spec.matrix.org/v1.7/server-server-api/#get_matrixfederationv1make_leaveroomiduserid) responses.
* the body of [v1](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv1send_leaveroomideventid) and [v2](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv2send_leaveroomideventid) `/send_leave` requests.
* the body of [v1](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv1inviteroomideventid) and [v2](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv2inviteroomideventid) `/invite` requests.
Previously, now fixed:
* ~[`PDU`](https://spec.matrix.org/v1.2/rooms/v9/#event-format)~ (fixed by #998)
* ~~The [redaction algorithm](https://spec.matrix.org/v1.7/rooms/v10/#redactions) of all room versions up to 10~~ (fixed by MSC3989 and room version 11)
* ~the body of [v1](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv1send_joinroomideventid) and [v2](https://spec.matrix.org/v1.7/server-server-api/#put_matrixfederationv2send_joinroomideventid) `/send_join` *responses*~ (fixed by #2050).
For completeness: `origin` is also specced as part of the [`X-Matrix` authentication mechanism](https://spec.matrix.org/v1.7/server-server-api/#request-authentication), where it is *not* redundant.
---
Related: https://github.com/matrix-org/synapse/issues/3816
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 by locating the transaction, /backfill, /make_join, /make_knock, /make_leave, /send_leave, and /invite sections in the Matrix server-server API specification. Check each schema for the redundant origin field and retain it in the X-Matrix authentication mechanism. Done means all listed redundant occurrences are removed consistently without changing the authentication definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100