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

Hardcode the state event fields table into the spec

Browse source 
See comment for why.
This commit is contained in:
Travis Ralston 2019-06-10 14:04:27 -06:00
parent 51698a5dd5
commit 37e2d81d58
1 changed files with 22 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

23
specification/client_server_api.rst
View file

@ -1340,7 +1340,28 @@ server-server API.
{{common_room_event_fields}}
{{common_state_event_fields}}
.. This is normally where we'd put the common_state_event_fields variable for the
.. magic table of what makes up a state event, however the table is verbose in our
.. custom rendering of swagger. To combat this, we just hardcode this particular
.. table.
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. |
+-----------+--------+-------------------------------------------------------------+
Size limits