From 978d9ea6dd3aaed06c3b3c57fb7112ee3d30888b Mon Sep 17 00:00:00 2001 From: Matthew Hodgson Date: Thu, 18 Aug 2016 14:04:21 +0100 Subject: [PATCH] fix the descriptions of the /room/.../state APIs to not be the wrong way round --- api/client-server/room_state.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api/client-server/room_state.yaml b/api/client-server/room_state.yaml index dedf6ede..d9064f0a 100644 --- a/api/client-server/room_state.yaml +++ b/api/client-server/room_state.yaml @@ -31,10 +31,9 @@ paths: put: summary: Send a state event to the given room. description: | - State events can be sent using this endpoint. This endpoint is - equivalent to calling `/rooms/{roomId}/state/{eventType}/{stateKey}` - with an empty `stateKey`. Previous state events with matching - `` and ``, and empty ``, will be overwritten. + State events can be sent using this endpoint. These events will be + overwritten if ````, ```` and ```` all + match. Requests to this endpoint **cannot use transaction IDs** like other ``PUT`` paths because they cannot be differentiated from the @@ -93,9 +92,10 @@ paths: put: summary: Send a state event to the given room. description: | - State events can be sent using this endpoint. These events will be - overwritten if ````, ```` and ```` all - match. This endpoint forces the state key to be the empty string. + State events can be sent using this endpoint. This endpoint is + equivalent to calling `/rooms/{roomId}/state/{eventType}/{stateKey}` + with an empty `stateKey`. Previous state events with matching + `` and ``, and empty ``, will be overwritten. Requests to this endpoint **cannot use transaction IDs** like other ``PUT`` paths because they cannot be differentiated from the