wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Move endpoint extras under endpoint's header

Browse source
This commit is contained in:
Andrew Morgan 2021-03-03 16:53:17 +00:00
parent c9f34e818e
commit c575f88d13
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
proposals/2403-knock.md
View file

@ -191,16 +191,13 @@ Additionally, extensions to the `GET /_matrix/client/r0/sync` endpoint are
introduced. These allow a client to receive information about the status of introduced. These allow a client to receive information about the status of
their knock attempt. their knock attempt.
The newly proposed endpoint requires authentication and can be rate limited.
### `POST /_matrix/client/r0/knock/{roomIdOrAlias}` ### `POST /_matrix/client/r0/knock/{roomIdOrAlias}`
Or the knocking equivalent of Or the knocking equivalent of
[`POST [`POST
/_matrix/client/r0/join/{roomIdOrAlias}`](https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-join-roomidoralias). /_matrix/client/r0/join/{roomIdOrAlias}`](https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-join-roomidoralias).
The path parameter (`roomIdOrAlias`) is either the room ID or the alias of The path parameter (`roomIdOrAlias`) is either the room ID or the alias of
the room you want to knock on. Additionally several `server_name` parameters the room you want to knock on. Additionally, several `server_name` parameters
can be specified via the query parameters. The post body accepts an optional can be specified via the query parameters. The post body accepts an optional
string parameter, `reason`, which is the reason you want to join the room. A string parameter, `reason`, which is the reason you want to join the room. A
request could look as follows: request could look as follows:
@ -214,6 +211,9 @@ Content-Type: application/json
} }
``` ```
This endpoint requires authentication and can be rate limited.
#### Responses: #### Responses:
##### Status code 200: ##### Status code 200:
The user knocked successfully. Example reply: The user knocked successfully. Example reply: