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

Clarify exactly what StrippedState is

Browse source 
Fixes https://github.com/matrix-org/matrix-doc/issues/2066

The expectation everywhere is that the `sender` is required. `/initialSync` references StrippedState through a `m.room.member` event reference, and does not need editing.
This commit is contained in:
Travis Ralston 2019-06-02 17:41:39 -06:00
parent dda7afa845
commit 7a07a6b358
9 changed files with 71 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

25
api/client-server/sync.yaml
View file

@ -212,30 +212,7 @@ paths:
events:
description: The StrippedState events that form the invite state.
items:
description: |-
A stripped down state event, with only the ``type``, ``state_key``,
``sender``, and ``content`` keys.
properties:
content:
description: The ``content`` for the event.
title: EventContent
type: object
state_key:
description: The ``state_key`` for the event.
type: string
type:
description: The ``type`` for the event.
type: string
sender:
description: The ``sender`` for the event.
type: string
required:
- type
- state_key
- content
- sender
title: StrippedState
type: object
$ref: "definitions/event-schemas/schema/stripped_state.yaml"
type: array
leave:
title: Left rooms

20
api/server-server/invites-v1.yaml
View file

@ -82,25 +82,7 @@ paths:
identify the room. The recommended events to include are the join rules,
canonical alias, avatar, and name of the room.
items:
type: object
title: Invite Room State Event
properties:
type:
type: string
description: The type of event.
example: "m.room.join_rules"
state_key:
type: string
description: The state key for the event. May be an empty string.
example: ""
content:
type: object
description: The content for the event.
sender:
type: string
description: The sender of the event.
example: "@someone:matrix.org"
required: ['type', 'state_key', 'content', 'sender']
$ref: "../client-server/definitions/event-schemas/schema/stripped_state.yaml"
example: [
{
"type": "m.room.join_rules",

20
api/server-server/invites-v2.yaml
View file

@ -83,25 +83,7 @@ paths:
identify the room. The recommended events to include are the join rules,
canonical alias, avatar, and name of the room.
items:
type: object
title: Invite Room State Event
properties:
type:
type: string
description: The type of event.
example: "m.room.join_rules"
state_key:
type: string
description: The state key for the event. May be an empty string.
example: ""
content:
type: object
description: The content for the event.
sender:
type: string
description: The sender of the event.
example: "@someone:matrix.org"
required: ['type', 'state_key', 'content', 'sender']
$ref: "../client-server/definitions/event-schemas/schema/stripped_state.yaml"
example: [
{
"type": "m.room.join_rules",