mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-08-05 07:27:52 +02:00
Compare commits
1 commit
528915200b
...
116a0ed2a0
| Author | SHA1 | Date | |
|---|---|---|---|
|
116a0ed2a0 |
|
|
@ -1 +0,0 @@
|
|||
Clarify formats of string types.
|
||||
|
|
@ -3936,28 +3936,28 @@ room to send events in the room:
|
|||
|
||||
Some rooms require that users be invited to it before they can join;
|
||||
others allow anyone to join. Whether a given room is an "invite-only"
|
||||
room is determined by the room state event [`m.room.join_rules`](#mroomjoin_rules).
|
||||
It can have one of the following values:
|
||||
room is determined by the room config key `m.room.join_rules`. It can
|
||||
have one of the following values:
|
||||
|
||||
`public`
|
||||
: This room is free for anyone to join without an invite.
|
||||
This room is free for anyone to join without an invite.
|
||||
|
||||
`invite`
|
||||
: This room can only be joined if you were invited.
|
||||
This room can only be joined if you were invited.
|
||||
|
||||
`knock`
|
||||
: This room can only be joined if you were invited, and allows anyone to
|
||||
This room can only be joined if you were invited, and allows anyone to
|
||||
request an invite to the room. Note that this join rule is only available
|
||||
in room versions [which support knocking](/rooms/#feature-matrix).
|
||||
|
||||
`restricted`
|
||||
: {{% added-in v="1.2" %}} This room can be joined if you were invited or if you are a member of another
|
||||
{{% added-in v="1.2" %}} `restricted`
|
||||
This room can be joined if you were invited or if you are a member of another
|
||||
room listed in the join rules. If the server cannot verify membership for any
|
||||
of the listed rooms then you can only join with an invite. Note that this rule
|
||||
is only expected to work in room versions [which support it](/rooms/#feature-matrix).
|
||||
|
||||
`knock_restricted`
|
||||
: {{% added-in v="1.3" %}} This room can be joined as though it was `restricted` *or* `knock`. If you
|
||||
{{% added-in v="1.3" %}} `knock_restricted`
|
||||
This room can be joined as though it was `restricted` *or* `knock`. If you
|
||||
interact with the room using knocking, the `knock` rule takes effect whereas
|
||||
trying to join the room without an invite applies the `restricted` join rule.
|
||||
Note that this rule is only expected to work in room versions
|
||||
|
|
|
|||
|
|
@ -37,8 +37,6 @@ paths:
|
|||
example: "!e42d8c:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -52,8 +50,6 @@ paths:
|
|||
user_id:
|
||||
type: string
|
||||
description: The fully qualified user ID of the user being banned.
|
||||
format: mx-user-id
|
||||
pattern: "^@"
|
||||
reason:
|
||||
x-addedInMatrixVersion: "1.1"
|
||||
type: string
|
||||
|
|
@ -112,8 +108,6 @@ paths:
|
|||
example: "!e42d8c:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -127,8 +121,6 @@ paths:
|
|||
user_id:
|
||||
type: string
|
||||
description: The fully qualified user ID of the user being unbanned.
|
||||
format: mx-user-id
|
||||
pattern: "^@"
|
||||
reason:
|
||||
x-addedInMatrixVersion: "1.1"
|
||||
type: string
|
||||
|
|
|
|||
|
|
@ -140,8 +140,6 @@ paths:
|
|||
server to invite everyone in the list to the newly created room.
|
||||
items:
|
||||
type: string
|
||||
format: mx-user-id
|
||||
pattern: "^@"
|
||||
invite_3pid:
|
||||
type: array
|
||||
description: |-
|
||||
|
|
@ -243,8 +241,6 @@ paths:
|
|||
room_id:
|
||||
type: string
|
||||
description: The created room's ID.
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
required:
|
||||
- room_id
|
||||
examples:
|
||||
|
|
|
|||
|
|
@ -20,14 +20,10 @@ properties:
|
|||
sender:
|
||||
type: string
|
||||
description: The Matrix ID of the user who issued the invite.
|
||||
format: mx-user-id
|
||||
pattern: "^@"
|
||||
example: "@alice:example.org"
|
||||
mxid:
|
||||
type: string
|
||||
description: The Matrix ID of the invitee.
|
||||
format: mx-user-id
|
||||
pattern: "^@"
|
||||
example: "@bob:example.org"
|
||||
token:
|
||||
type: string
|
||||
|
|
|
|||
|
|
@ -33,8 +33,6 @@ paths:
|
|||
example: "#monkeys:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-alias
|
||||
pattern: "^#"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -44,8 +42,6 @@ paths:
|
|||
room_id:
|
||||
type: string
|
||||
description: The room ID to set.
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
required:
|
||||
- room_id
|
||||
example: {
|
||||
|
|
@ -108,8 +104,6 @@ paths:
|
|||
example: "#monkeys:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-alias
|
||||
pattern: "^#"
|
||||
responses:
|
||||
"200":
|
||||
description: The room ID and other information for this alias.
|
||||
|
|
@ -121,15 +115,12 @@ paths:
|
|||
room_id:
|
||||
type: string
|
||||
description: The room ID for this room alias.
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
servers:
|
||||
type: array
|
||||
description: A list of servers that are aware of this room alias.
|
||||
items:
|
||||
type: string
|
||||
description: A server which is aware of this room alias.
|
||||
format: mx-server-name
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
|
|
@ -194,8 +185,6 @@ paths:
|
|||
example: "#monkeys:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-alias
|
||||
pattern: "^#"
|
||||
responses:
|
||||
"200":
|
||||
description: The mapping was deleted.
|
||||
|
|
@ -252,8 +241,6 @@ paths:
|
|||
example: "!abc123:example.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
responses:
|
||||
"200":
|
||||
description: The list of local aliases for the room.
|
||||
|
|
@ -267,8 +254,6 @@ paths:
|
|||
description: The server's local aliases on the room. Can be empty.
|
||||
items:
|
||||
type: string
|
||||
format: mx-room-alias
|
||||
pattern: "^#"
|
||||
required:
|
||||
- aliases
|
||||
examples:
|
||||
|
|
|
|||
|
|
@ -48,8 +48,6 @@ paths:
|
|||
example: "!d41d8cd:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -63,8 +61,6 @@ paths:
|
|||
user_id:
|
||||
type: string
|
||||
description: The fully qualified user ID of the invitee.
|
||||
format: mx-user-id
|
||||
pattern: "^@"
|
||||
reason:
|
||||
x-addedInMatrixVersion: "1.1"
|
||||
type: string
|
||||
|
|
|
|||
|
|
@ -43,8 +43,6 @@ paths:
|
|||
example: "!d41d8cd:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -80,8 +78,6 @@ paths:
|
|||
room_id:
|
||||
type: string
|
||||
description: The joined room ID.
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
required:
|
||||
- room_id
|
||||
examples:
|
||||
|
|
@ -140,13 +136,7 @@ paths:
|
|||
required: true
|
||||
example: "#monkeys:matrix.org"
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
- type: string
|
||||
format: mx-room-alias
|
||||
pattern: "^#"
|
||||
type: string
|
||||
- in: query
|
||||
name: via
|
||||
x-addedInMatrixVersion: "1.12"
|
||||
|
|
@ -160,7 +150,6 @@ paths:
|
|||
type: array
|
||||
items:
|
||||
type: string
|
||||
format: mx-server-name
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -196,8 +185,6 @@ paths:
|
|||
room_id:
|
||||
type: string
|
||||
description: The joined room ID.
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
required:
|
||||
- room_id
|
||||
examples:
|
||||
|
|
|
|||
|
|
@ -39,8 +39,6 @@ paths:
|
|||
example: "!e42d8c:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -54,8 +52,6 @@ paths:
|
|||
user_id:
|
||||
type: string
|
||||
description: The fully qualified user ID of the user being kicked.
|
||||
format: mx-user-id
|
||||
pattern: "^@"
|
||||
reason:
|
||||
type: string
|
||||
description: |-
|
||||
|
|
|
|||
|
|
@ -47,13 +47,7 @@ paths:
|
|||
required: true
|
||||
example: "#monkeys:matrix.org"
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
- type: string
|
||||
format: mx-room-alias
|
||||
pattern: "^#"
|
||||
type: string
|
||||
- in: query
|
||||
name: via
|
||||
x-addedInMatrixVersion: "1.12"
|
||||
|
|
@ -67,7 +61,6 @@ paths:
|
|||
type: array
|
||||
items:
|
||||
type: string
|
||||
format: mx-server-name
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -95,8 +88,6 @@ paths:
|
|||
room_id:
|
||||
type: string
|
||||
description: The knocked room ID.
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
required:
|
||||
- room_id
|
||||
examples:
|
||||
|
|
|
|||
|
|
@ -54,8 +54,6 @@ paths:
|
|||
example: "!nkl290a:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -115,8 +113,6 @@ paths:
|
|||
example: "!au1ba7o:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
responses:
|
||||
"200":
|
||||
description: The room has been forgotten.
|
||||
|
|
|
|||
|
|
@ -39,8 +39,6 @@ paths:
|
|||
description: The ID of each room in which the user has `joined` membership.
|
||||
items:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
examples:
|
||||
response:
|
||||
value: {
|
||||
|
|
|
|||
|
|
@ -31,8 +31,6 @@ paths:
|
|||
example: "!curbf:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
responses:
|
||||
"200":
|
||||
description: The visibility of the room in the directory.
|
||||
|
|
@ -86,8 +84,6 @@ paths:
|
|||
example: "!curbf:matrix.org"
|
||||
schema:
|
||||
type: string
|
||||
format: mx-room-id
|
||||
pattern: "^!"
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
@ -162,7 +158,6 @@ paths:
|
|||
to the local server. Case sensitive.
|
||||
schema:
|
||||
type: string
|
||||
format: mx-server-name
|
||||
responses:
|
||||
"200":
|
||||
description: A list of the published rooms on the server.
|
||||
|
|
@ -191,7 +186,6 @@ paths:
|
|||
to the local server. Case sensitive.
|
||||
schema:
|
||||
type: string
|
||||
format: mx-server-name
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
|
|
|
|||
Loading…
Reference in a new issue