Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-06 19:54:09 +01:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

fix the descriptions of the /room/.../state APIs to not be the wrong way round

Browse source
This commit is contained in:
Matthew Hodgson 2016-08-18 14:04:21 +01:00
parent 16a4903656
commit 978d9ea6dd
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
api/client-server/room_state.yaml
View file

@ -31,10 +31,9 @@ paths:
put: put:
summary: Send a state event to the given room. summary: Send a state event to the given room.
description: | description: |
State events can be sent using this endpoint. This endpoint is State events can be sent using this endpoint. These events will be
equivalent to calling `/rooms/{roomId}/state/{eventType}/{stateKey}` overwritten if ``<room id>``, ``<event type>`` and ``<state key>`` all
with an empty `stateKey`. Previous state events with matching match.
`<roomId>` and `<eventType>`, and empty `<stateKey>`, will be overwritten.
Requests to this endpoint **cannot use transaction IDs** Requests to this endpoint **cannot use transaction IDs**
like other ``PUT`` paths because they cannot be differentiated from the like other ``PUT`` paths because they cannot be differentiated from the
@ -93,9 +92,10 @@ paths:
put: put:
summary: Send a state event to the given room. summary: Send a state event to the given room.
description: | description: |
State events can be sent using this endpoint. These events will be State events can be sent using this endpoint. This endpoint is
overwritten if ``<room id>``, ``<event type>`` and ``<state key>`` all equivalent to calling `/rooms/{roomId}/state/{eventType}/{stateKey}`
match. This endpoint forces the state key to be the empty string. with an empty `stateKey`. Previous state events with matching
`<roomId>` and `<eventType>`, and empty `<stateKey>`, will be overwritten.
Requests to this endpoint **cannot use transaction IDs** Requests to this endpoint **cannot use transaction IDs**
like other ``PUT`` paths because they cannot be differentiated from the like other ``PUT`` paths because they cannot be differentiated from the