From 37e2d81d580083f8d7ed2f1a99e368231aab299c Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 10 Jun 2019 14:04:27 -0600 Subject: [PATCH] Hardcode the state event fields table into the spec See comment for why. --- specification/client_server_api.rst | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index b67beca1..ad58fd1a 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -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