matrix-org / matrix-org/gomatrixserverlib

`fclient` has a concept of "Invite v3", which doesn't exist

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

Nobody has claimed this yet.

Dominant language
Go
Stars
67
Forks
60
PR merge metrics
No merged PRs in 30d

Description

https://github.com/matrix-org/gomatrixserverlib/blob/4fe595dc7f589ccf975b2a780d37be6e68758964/fclient/invitev3.go#L26
and
https://github.com/matrix-org/gomatrixserverlib/blob/4fe595dc7f589ccf975b2a780d37be6e68758964/fclient/federationclient.go#L35

the comment states it's a /v3/invite request, but no such endpoint exists. At best there's a v1 and a v2 invite API, but not a v3.

It appears as though the v2 invite is actually a v2 invite and v3 is also a v2 invite with extra unmarshall steps. v1 does not appear to have an implementation at all.

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 with fclient/invitev3.go and fclient/federationclient.go, then compare their comments and behavior with the linked Matrix v1.19 v1 and v2 invite API specifications. Verify whether the v3 concept is actually a v2 invite with extra unmarshalling and whether a v1 implementation exists. Done means the library's endpoint terminology and references accurately describe the supported invite APIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.