matrix-org / matrix-org/matrix-spec
Sending invites over federation is badly specified
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 330
- Forks
- 150
- Avg merge
- 2h 21m
- Merged PRs (30d)
- 3
Description
Link to problem area: https://matrix.org/docs/spec/server_server/r0.1.4#put-matrix-federation-v2-invite-roomid-eventid
Issue
The PUT /_matrix/federation/v2/ route (and v1 too) define a type Invite Event that doesn't have any of the expected PDU fields that should be there.
Expected behaviour
The type should be renamed to Invite PDU or Invite Event PDU and the missing fields added (for the v1 endpoint, the request fields probably have to be updated too).
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 at the linked Matrix federation v2 invite endpoint and compare its Invite Event definition with the expected PDU fields. Check the corresponding v1 endpoint as well, including its request fields. Done means the type is correctly named, the missing PDU fields are documented, and both endpoint definitions are consistent.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100