Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-12 06:24:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

make clear displayname and avatar_url are optional, add status codes

Browse source
This commit is contained in:
Sorunome 2020-01-13 12:52:22 +01:00
parent 13964988f4
commit f0411a3cc5
No known key found for this signature in database
GPG key ID: 63E31F7B5993A9C4
1 changed files with 30 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
proposals/2403-knock.md
View file

@ -6,7 +6,8 @@ said room.
# Proposal # Proposal
This proposal implements the reserved "knock" membership type for the `m.room.member` state event. This proposal implements the reserved "knock" membership type for the `m.room.member` state event.
This state event indicates that a user knocks a room, that is asking for permission to join. It This state event indicates that a user knocks a room, that is asking for permission to join. It
contains an optional "reason" parameter to specify the reason you want to join. This membership can contains an optional "reason" parameter to specify the reason you want to join. Like other
memtership types the parameters "displayname" and "avatar_url" are optional. This membership can
be set from users who aren't currently in said room. An example for the membership would look as be set from users who aren't currently in said room. An example for the membership would look as
follows: follows:
```json ```json
@ -77,6 +78,14 @@ The user knocked successfully. Empty reply:
{} {}
``` ```
#### Status code 400:
This request was invalid, e.g. bad JSON. Example reply:
```json
{
"errcode": "M_UNKNOWN",
"error": "An unknown error occurred"}
```
#### Status code 403: #### Status code 403:
The user wasn't allowed to knock (e.g. they are banned). Error reply: The user wasn't allowed to knock (e.g. they are banned). Error reply:
```json ```json
@ -86,6 +95,16 @@ The user wasn't allowed to knock (e.g. they are banned). Error reply:
} }
``` ```
#### Status code 429:
This request was rate-limited. Example reply:
```json
{
"errcode": "M_LIMIT_EXCEEDED",
"error": "Too many requests",
"retry_after_ms": 2000
}
```
## Server-Server API ## Server-Server API
The new endpoint for the server-server API is `PUT /_matrix/federation/v2/knock/{roomId}/{eventId}`. The new endpoint for the server-server API is `PUT /_matrix/federation/v2/knock/{roomId}/{eventId}`.
The path parameters are the room id you want to knock and the event id of the knock event. The post The path parameters are the room id you want to knock and the event id of the knock event. The post
@ -123,12 +142,22 @@ The knock was performed successfully. The knock event is sent back with the "eve
"state_key": "@alice:example.org", "state_key": "@alice:example.org",
"content": { "content": {
"membership": "knock", "membership": "knock",
"displayname": "Alice",
"avatar_url": "mxc://example.org/avatar",
"reason": "I want to join this room as I really love foxes!" "reason": "I want to join this room as I really love foxes!"
} }
} }
} }
``` ```
#### Status code 400:
This request was invalid, e.g. bad JSON. Example reply:
```json
{
"errcode": "M_UNKNOWN",
"error": "An unknown error occurred"}
```
#### Status code 403: #### Status code 403:
The user wasn't allowed to knock. Error reply: The user wasn't allowed to knock. Error reply:
```json ```json