Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify that prev_content is part of unsigned, always #2648

Closed
wants to merge 1 commit into from
Closed

Clarify that prev_content is part of unsigned, always #2648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2648.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that ``prev_content`` is part of ``unsigned``, always.
15 changes: 10 additions & 5 deletions event-schemas/schema/core-event-schema/sync_state_event.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,6 @@ allOf:
description: In addition to the Room Event fields, State Events have the following
additional fields.
properties:
prev_content:
description: Optional. The previous ``content`` for this event. If there is no
previous content, this key will be missing.
title: EventContent
type: object
state_key:
description: A unique key which defines the overwriting semantics for this piece
of room state. This value is often a zero-length string. The presence of this
Expand All @@ -33,6 +28,16 @@ properties:
as room members. With the exception of a few events, state events set with a
given user's ID as the state key MUST only be set by that user.
type: string
unsigned:
description: Optional extra information about the event.
properties:
prev_content:
description: Optional. The previous ``content`` for this event. If there is no
previous content, this key will be missing.
title: EventContent
type: object
title: UnsignedData
type: object
required:
- state_key
title: State Event
Expand Down
4 changes: 2 additions & 2 deletions event-schemas/schema/m.room.member
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ description: |-

The ``membership`` for a given user can change over time. The table below represents the various changes
over time and how clients and servers must interpret those changes. Previous membership can be retrieved
from the ``prev_content`` object on an event. If not present, the user's previous membership must be assumed
as ``leave``.
from the ``prev_content`` object inside an event's ``unsigned`` object. If not present, the user's
previous membership must be assumed as ``leave``.

.. TODO: Improve how this table is written? We use a csv-table to get around vertical header restrictions.

Expand Down
30 changes: 15 additions & 15 deletions specification/client_server_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1553,21 +1553,21 @@ State Event Fields

In addition to the fields of a Room Event, State Events have the following fields.

+--------------+--------------+-------------------------------------------------------------+
| Key | Type | Description |
+==============+==============+=============================================================+
| state_key | string | **Required.** A unique key which defines the overwriting |
| | | semantics for this piece of room state. This value is often |
| | | a zero-length string. The presence of this key makes this |
| | | event a State Event. State keys starting with an ``@`` are |
| | | reserved for referencing user IDs, such as room members. |
| | | With the exception of a few events, state events set with |
| | | a given user's ID as the state key MUST only be set by that |
| | | user. |
+--------------+--------------+-------------------------------------------------------------+
| prev_content | EventContent | Optional. The previous ``content`` for this event. If there |
| | | is no previous content, this key will be missing. |
+--------------+--------------+-------------------------------------------------------------+
+-------------------+--------------+-------------------------------------------------------------+
| Key | Type | Description |
+===================+==============+=============================================================+
| state_key | string | **Required.** A unique key which defines the overwriting |
| | | semantics for this piece of room state. This value is often |
| | | a zero-length string. The presence of this key makes this |
| | | event a State Event. State keys starting with an ``@`` are |
| | | reserved for referencing user IDs, such as room members. |
| | | With the exception of a few events, state events set with |
| | | a given user's ID as the state key MUST only be set by that |
| | | user. |
+-------------------+--------------+-------------------------------------------------------------+
| prev_content | EventContent | Optional. The previous ``content`` for this event. If there |
| (inside unsigned) | | is no previous content, this key will be missing. |
+-------------------+--------------+-------------------------------------------------------------+


Size limits
Expand Down