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

Describe and hoist stripped state to a first-class citizen (#3606)

Browse source 
* Describe and hoist stripped state to a first-class citizen

Fixes https://github.com/matrix-org/matrix-doc/issues/3413
MSC: https://github.com/matrix-org/matrix-doc/pull/3173

* Add changelog

* may->can for clarity

* Update text per review
This commit is contained in:
Travis Ralston 2022-01-05 10:57:59 -07:00 • committed by GitHub
parent 224773dc6a
commit 56532dd688
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 83 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

2
data/event-schemas/schema/stripped_state.yaml → data/event-schemas/schema/core-event-schema/stripped_state.yaml
View file

@ -18,7 +18,7 @@
# difficult because the schema would be at two different locations, with
# different relative pathing.
title: StrippedState
title: StrippedStateEvent
type: object
description: |-
A stripped down state event, with only the `type`, `state_key`,

8
data/event-schemas/schema/m.room.member.yaml
View file

@ -19,8 +19,8 @@ description: |-
The `third_party_invite` property will be set if this invite is an `invite` event and is the successor of an `m.room.third_party_invite` event, and absent otherwise.
This event may also include an `invite_room_state` key inside the event's `unsigned` data.
If present, this contains an array of `StrippedState` Events. These events provide information
on a subset of state events such as the room name.
If present, this contains an array of [stripped state events](/client-server-api/#stripped-state)
to assist the receiver in identifying the room.
The user for which a membership applies is represented by the `state_key`. Under some conditions,
the `sender` and `state_key` may not match - this may be interpreted as the `sender` affecting
@ -136,7 +136,7 @@ properties:
state for `m.room.avatar`, `m.room.canonical_alias`, `m.room.join_rules`, and `m.room.name`
SHOULD be included.
items:
$ref: "stripped_state.yaml"
$ref: "core-event-schema/stripped_state.yaml"
type: array
knock_room_state:
description: |-
@ -145,7 +145,7 @@ properties:
the state for `m.room.avatar`, `m.room.canonical_alias`, `m.room.join_rules`, `m.room.name`,
and `m.room.encryption` SHOULD be included.
items:
$ref: "stripped_state.yaml"
$ref: "core-event-schema/stripped_state.yaml"
type: array
title: The current membership state of a user in the room.
type: object