Further tweaks to the room send and state APIs

- fix confusion re empty/absent state_keys
- move 'types of room events' section earlier in the 'Events' section
- remove some redundant anchors
This commit is contained in:
Richard van der Hoff 2015-10-23 16:58:55 +01:00
parent 587a8ba7ce
commit 1945697456
2 changed files with 29 additions and 30 deletions

View file

@ -24,9 +24,11 @@ paths:
description: |
State events can be sent using this endpoint. These events will be
overwritten if ``<room id>``, ``<event type>`` and ``<state key>`` all
match. If the state event has no ``state_key``, it can be omitted from
the path. These requests **cannot use transaction IDs** like other
``PUT`` paths because they cannot be differentiated from the
match. If the state event has an empty ``state_key``, it can be
omitted from the path.
Requests to this endpoint **cannot use transaction IDs**
like other ``PUT`` paths because they cannot be differentiated from the
``state_key``. Furthermore, ``POST`` is unsupported on state paths.
The body of the request should be the content object of the event; the