mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-05-01 14:44:09 +02:00
Compare commits
4 commits
e313db9909
...
949cd8c3f8
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
949cd8c3f8 | ||
|
|
67a2aa4761 | ||
|
|
3c17aa3789 | ||
|
|
506bc1a164 |
|
|
@ -0,0 +1,2 @@
|
||||||
|
Clarify that the stripped state in `invite_state` and `knock_state` in `GET /sync` response must
|
||||||
|
include the full `m.room.member` event of the user.
|
||||||
1
changelogs/internal/newsfragments/2189.clarification
Normal file
1
changelogs/internal/newsfragments/2189.clarification
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
Specify a correct spelling for "display name".
|
||||||
|
|
@ -310,8 +310,14 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
The [stripped state events](/client-server-api/#stripped-state) that form the
|
The [stripped state events](/client-server-api/#stripped-state) that form the
|
||||||
invite state.
|
invite state.
|
||||||
|
|
||||||
|
MUST also include the `m.room.member` event of the user with a membership of
|
||||||
|
`invite`, and using the same event format as joined rooms with the `event_id`
|
||||||
|
and `origin_server_ts` fields.
|
||||||
items:
|
items:
|
||||||
$ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
|
anyOf:
|
||||||
|
- $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
|
||||||
|
- $ref: definitions/client_event_without_room_id.yaml
|
||||||
type: array
|
type: array
|
||||||
knock:
|
knock:
|
||||||
title: Knocked rooms
|
title: Knocked rooms
|
||||||
|
|
@ -335,8 +341,14 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
The [stripped state events](/client-server-api/#stripped-state) that form the
|
The [stripped state events](/client-server-api/#stripped-state) that form the
|
||||||
knock state.
|
knock state.
|
||||||
|
|
||||||
|
MUST also include the `m.room.member` event of the user with a membership of
|
||||||
|
`knock`, and using the same event format as joined rooms with the `event_id` and
|
||||||
|
`origin_server_ts` fields.
|
||||||
items:
|
items:
|
||||||
$ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
|
anyOf:
|
||||||
|
- $ref: ../../event-schemas/schema/core-event-schema/stripped_state.yaml
|
||||||
|
- $ref: definitions/client_event_without_room_id.yaml
|
||||||
type: array
|
type: array
|
||||||
leave:
|
leave:
|
||||||
title: Left rooms
|
title: Left rooms
|
||||||
|
|
@ -548,6 +560,8 @@ paths:
|
||||||
"sender": "@alice:example.com",
|
"sender": "@alice:example.com",
|
||||||
"type": "m.room.member",
|
"type": "m.room.member",
|
||||||
"state_key": "@bob:example.com",
|
"state_key": "@bob:example.com",
|
||||||
|
"event_id": "$19dl9d3848dJLle:example.com",
|
||||||
|
"origin_server_ts": 1432735439654,
|
||||||
"content": {
|
"content": {
|
||||||
"membership": "invite"
|
"membership": "invite"
|
||||||
}
|
}
|
||||||
|
|
@ -572,6 +586,8 @@ paths:
|
||||||
"sender": "@bob:example.com",
|
"sender": "@bob:example.com",
|
||||||
"type": "m.room.member",
|
"type": "m.room.member",
|
||||||
"state_key": "@bob:example.com",
|
"state_key": "@bob:example.com",
|
||||||
|
"event_id": "$Fg83Kl3764di23a:example.com",
|
||||||
|
"origin_server_ts": 143273039402,
|
||||||
"content": {
|
"content": {
|
||||||
"membership": "knock"
|
"membership": "knock"
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -60,6 +60,11 @@ General
|
||||||
you have at home. "identity server" is clear, whereas "identityserver" is
|
you have at home. "identity server" is clear, whereas "identityserver" is
|
||||||
horrible.
|
horrible.
|
||||||
|
|
||||||
|
* When talking about a user's "display name", it is spelt as two words. In
|
||||||
|
identifiers such as within the content of an ``m.room.member`` event, it is
|
||||||
|
spelt as a single word, ``displayname``. (There are some historical exceptions
|
||||||
|
to this where the identifier is spelt ``display_name``.)
|
||||||
|
|
||||||
* Lists should:
|
* Lists should:
|
||||||
|
|
||||||
* Be introduced with a colon.
|
* Be introduced with a colon.
|
||||||
|
|
@ -84,12 +89,12 @@ Changes between spec versions
|
||||||
Sections should reference the Matrix spec version they were added/changed in. This
|
Sections should reference the Matrix spec version they were added/changed in. This
|
||||||
is often a guess at what the next version will be - please use the currently released
|
is often a guess at what the next version will be - please use the currently released
|
||||||
version with a minor version bump as the referenced version. For example, if the
|
version with a minor version bump as the referenced version. For example, if the
|
||||||
current version is `v1.1` then annotate your changes with `v1.2`.
|
current version is ``v1.1`` then annotate your changes with ``v1.2``.
|
||||||
|
|
||||||
"Added/changed in" tags can be documented as the following:
|
"Added/changed in" tags can be documented as the following:
|
||||||
|
|
||||||
* `{{% added-in v="1.2" %}}` or `{{% changed-in v="1.2" %}}` within Markdown documents.
|
* ``{{% added-in v="1.2" %}}`` or ``{{% changed-in v="1.2" %}}`` within Markdown documents.
|
||||||
* `x-addedInMatrixVersion` and `x-changedInMatrixVersion` within OpenAPI.
|
* ``x-addedInMatrixVersion`` and ``x-changedInMatrixVersion`` within OpenAPI.
|
||||||
|
|
||||||
OpenAPI
|
OpenAPI
|
||||||
~~~~~~~
|
~~~~~~~
|
||||||
|
|
@ -185,4 +190,4 @@ Describing grammar
|
||||||
|
|
||||||
Use `RFC5234-style ABNF <https://datatracker.ietf.org/doc/html/rfc5234>`_ when describing
|
Use `RFC5234-style ABNF <https://datatracker.ietf.org/doc/html/rfc5234>`_ when describing
|
||||||
the grammar for something in the spec, such as user IDs or server names. Use lowercase
|
the grammar for something in the spec, such as user IDs or server names. Use lowercase
|
||||||
and underscore-delimited element names (`user_id`, not `UserID` or `user-id`).
|
and underscore-delimited element names (``user_id``, not ``UserID`` or ``user-id``).
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue