matrix-org/dendrite

Implement knocking on rooms

Open

#3,095 opened on Jun 1, 2023

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (658 forks)auto 404
help wantednew-endpointsspec-compliance

Repository metrics

Stars
 (5,632 stars)
PR merge metrics
 (PR metrics pending)

Description

Version 1.1 of the spec introduced knocking on rooms (MSC2403). We currently don't implement the following endpoints:

Client API: POST /_matrix/client/v3/knock/{roomIdOrAlias} spec

further reading

Server-Server API: GET /_matrix/federation/v1/make_knock/{roomId}/{userId} spec PUT /_matrix/federation/v1/send_knock/{roomId}/{eventId} spec

further reading

Contributor guide

Research direction
Read the Matrix specification for knocking (MSC2403) and the existing codebase for similar membership endpoints (e.g., join/leave) to understand the patterns. Then implement the client API endpoint POST / matrix/client/v3/knock/{roomIdOrAlias} and the server server endpoints GET / matrix/federation/v1/make knock/{roomId}/{userId} and PUT / matrix/federation/v1/send knock/{roomId}/{eventId}.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoMatrix spec knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55