Nicer formatting for the PDU field documentation

pull/977/head
Mark Haines 10 years ago
parent ae27cbe1a4
commit 5e4b8798a4

@ -110,8 +110,9 @@ receiving an "empty" transaction.)
PDUs and EDUs
-------------
.. WARNING::
This section may be misleading or inaccurate.
Common PDU Fields
~~~~~~~~~~~~~~~~~
All PDUs have:
- An ID
@ -121,24 +122,29 @@ All PDUs have:
(regardless of which origin sent them)
``context``
+++++++++++
Type:
String
Description:
Event context identifier
``origin``
++++++++++
Type:
String
Description:
DNS name of homeserver that created this PDU.
``pdu_id``
++++++++++
Type:
String
Description:
Unique identifier for PDU within the context for the originating homeserver
``ts``
++++++
Type:
Integer
Description:
@ -146,12 +152,14 @@ All PDUs have:
created.
``pdu_type``
++++++++++++
Type:
String
Description:
PDU event type.
``prev_pdus``
+++++++++++++
Type:
List of pairs of strings
Description:
@ -159,6 +167,7 @@ All PDUs have:
homeserver was aware of for this context when it made this PDU.
``depth``
+++++++++
Type:
Integer
Description:
@ -169,45 +178,55 @@ All PDUs have:
- Update this structure so that 'pdu_id' is a two-element [origin,ref] pair
like the prev_pdus are
State Update PDU Fields
~~~~~~~~~~~~~~~~~~~~~~~
For state updates:
``is_state``
++++++++++++
Type:
Boolean
Description:
True if this PDU is updating state.
``state_key``
+++++++++++++
Type:
String
Description:
Optional key identifying the updated state within the context.
``power_level``
+++++++++++++++
Type:
Integer
Description:
The asserted power level of the user performing the update.
``required_power_level``
++++++++++++++++++++++++
Type:
Integer
Description:
The required power level needed to replace this update.
``prev_state_id``
+++++++++++++++++
Type:
String
Description:
PDU event type.
``prev_state_origin``
+++++++++++++++++++++
Type:
String
Description:
The PDU id of the update this replaces.
``user_id``
+++++++++++
Type:
String
Description:

Loading…
Cancel
Save