mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-28 21:34:09 +02:00
Compare commits
5 commits
0278bf6839
...
29d0311d0f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
29d0311d0f | ||
|
|
65b1db721d | ||
|
|
c39c7d0680 | ||
|
|
72b34b863f | ||
|
|
4d84d75bb6 |
|
|
@ -0,0 +1 @@
|
||||||
|
Clarify behaviour when the `topic` key of a `m.room.topic` event is absent, null, or empty.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Fix the example of the `GET /sync` endpoint and the `m.room.member` example used in several places.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Add a note to the invite endpoints that invites to local users may be received twice over federation if the homeserver is already in the room.
|
||||||
|
|
@ -441,17 +441,57 @@ paths:
|
||||||
"state": {
|
"state": {
|
||||||
"events": [
|
"events": [
|
||||||
{
|
{
|
||||||
"$ref": "../../event-schemas/examples/m.room.member.yaml"
|
"content": {
|
||||||
|
"avatar_url": "mxc://example.org/SFHyPlCeYUSFFxlgbQYZmoEoe",
|
||||||
|
"displayname": "Example user",
|
||||||
|
"membership": "join"
|
||||||
|
},
|
||||||
|
"event_id": "$143273976499sgjks:example.org",
|
||||||
|
"origin_server_ts": 1432735824653,
|
||||||
|
"sender": "@example:example.org",
|
||||||
|
"state_key": "@example:example.org",
|
||||||
|
"type": "m.room.member",
|
||||||
|
"unsigned": {
|
||||||
|
"age": 45603,
|
||||||
|
"membership": "join"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"timeline": {
|
"timeline": {
|
||||||
"events": [
|
"events": [
|
||||||
{
|
{
|
||||||
"$ref": "../../event-schemas/examples/m.room.member.yaml"
|
"content": {
|
||||||
|
"avatar_url": "mxc://example.org/SEsfnsuifSDFSSEF",
|
||||||
|
"displayname": "Alice Margatroid",
|
||||||
|
"membership": "join",
|
||||||
|
"reason": "Looking for support"
|
||||||
|
},
|
||||||
|
"event_id": "$143273582443PhrSn:example.org",
|
||||||
|
"origin_server_ts": 1432735824653,
|
||||||
|
"sender": "@alice:example.org",
|
||||||
|
"state_key": "@alice:example.org",
|
||||||
|
"type": "m.room.member",
|
||||||
|
"unsigned": {
|
||||||
|
"age": 1234,
|
||||||
|
"membership": "join"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"$ref": "../../event-schemas/examples/m.room.message$m.text.yaml"
|
"content": {
|
||||||
|
"body": "This is an example text message",
|
||||||
|
"format": "org.matrix.custom.html",
|
||||||
|
"formatted_body": "<b>This is an example text message</b>",
|
||||||
|
"msgtype": "m.text"
|
||||||
|
},
|
||||||
|
"event_id": "$143273582443PhrSn:example.org",
|
||||||
|
"origin_server_ts": 1432735824653,
|
||||||
|
"sender": "@example:example.org",
|
||||||
|
"type": "m.room.message",
|
||||||
|
"unsigned": {
|
||||||
|
"age": 1234,
|
||||||
|
"membership": "join"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"limited": true,
|
"limited": true,
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,7 @@ paths:
|
||||||
put:
|
put:
|
||||||
summary: Invites a remote user to a room
|
summary: Invites a remote user to a room
|
||||||
description: |-
|
description: |-
|
||||||
Invites a remote user to a room. Once the event has been signed by both the inviting
|
Invites a remote user to a room. Once the event has been signed by both the inviting
|
||||||
homeserver and the invited homeserver, it can be sent to all of the servers in the
|
homeserver and the invited homeserver, it can be sent to all of the servers in the
|
||||||
room by the inviting homeserver.
|
room by the inviting homeserver.
|
||||||
|
|
||||||
|
|
@ -32,6 +32,10 @@ paths:
|
||||||
[room version specification](/rooms) for precise event formats. **The request and response
|
[room version specification](/rooms) for precise event formats. **The request and response
|
||||||
bodies here describe the common event fields in more detail and may be missing other
|
bodies here describe the common event fields in more detail and may be missing other
|
||||||
required fields for a PDU.**
|
required fields for a PDU.**
|
||||||
|
|
||||||
|
Also note that if the remote homeserver is already in the room, it will receive the
|
||||||
|
invite event twice; once through this endpoint, and again through a [federation
|
||||||
|
transaction](https://spec.matrix.org/v1.13/server-server-api/#transactions).
|
||||||
operationId: sendInviteV1
|
operationId: sendInviteV1
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
|
||||||
|
|
@ -24,7 +24,7 @@ paths:
|
||||||
This API is nearly identical to the v1 API with the exception of the request
|
This API is nearly identical to the v1 API with the exception of the request
|
||||||
body being different, and the response format fixed.
|
body being different, and the response format fixed.
|
||||||
|
|
||||||
Invites a remote user to a room. Once the event has been signed by both the inviting
|
Invites a remote user to a room. Once the event has been signed by both the inviting
|
||||||
homeserver and the invited homeserver, it can be sent to all of the servers in the
|
homeserver and the invited homeserver, it can be sent to all of the servers in the
|
||||||
room by the inviting homeserver.
|
room by the inviting homeserver.
|
||||||
|
|
||||||
|
|
@ -36,6 +36,10 @@ paths:
|
||||||
[room version specification](/rooms) for precise event formats. **The request and response
|
[room version specification](/rooms) for precise event formats. **The request and response
|
||||||
bodies here describe the common event fields in more detail and may be missing other
|
bodies here describe the common event fields in more detail and may be missing other
|
||||||
required fields for a PDU.**
|
required fields for a PDU.**
|
||||||
|
|
||||||
|
Also note that if the remote homeserver is already in the room, it will receive the
|
||||||
|
invite event twice; once through this endpoint, and again through a [federation
|
||||||
|
transaction](https://spec.matrix.org/v1.13/server-server-api/#transactions).
|
||||||
operationId: sendInviteV2
|
operationId: sendInviteV2
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,7 @@
|
||||||
{
|
{
|
||||||
"$ref": "core/state_event.json",
|
"$ref": "core/state_event.json",
|
||||||
"state_key": "@alice:example.org",
|
"state_key": "@alice:example.org",
|
||||||
|
"sender": "@alice:example.org",
|
||||||
"type": "m.room.member",
|
"type": "m.room.member",
|
||||||
"content": {
|
"content": {
|
||||||
"membership": "join",
|
"membership": "join",
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,14 @@
|
||||||
---
|
---
|
||||||
allOf:
|
allOf:
|
||||||
- $ref: core-event-schema/state_event.yaml
|
- $ref: core-event-schema/state_event.yaml
|
||||||
description: 'A topic is a short message detailing what is currently being discussed in the room. It can also be used as a way to display extra information about the room, which may not be suitable for the room name. The room topic can also be set when creating a room using `/createRoom` with the `topic` key.'
|
description: |-
|
||||||
|
A topic is a short message detailing what is currently being discussed in the room.
|
||||||
|
It can also be used as a way to display extra information about the room, which may not
|
||||||
|
be suitable for the room name.
|
||||||
|
The room topic can also be set when creating a room using `/createRoom` with the `topic` key.'
|
||||||
|
|
||||||
|
If the `topic` property is absent, null, or empty then the topic is unset. In other words,
|
||||||
|
an empty `topic` property effectively resets the room to having no topic.
|
||||||
properties:
|
properties:
|
||||||
content:
|
content:
|
||||||
properties:
|
properties:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue