From 1140c0c05b73d081f421555465caa6bdb34a8c1e Mon Sep 17 00:00:00 2001 From: Will Hunt Date: Fri, 22 Jun 2018 16:23:05 +0100 Subject: [PATCH] Document StateEvent for /createRoom (#1329) --- api/client-server/create_room.yaml | 4 ++++ changelogs/client_server.rst | 2 ++ 2 files changed, 6 insertions(+) diff --git a/api/client-server/create_room.yaml b/api/client-server/create_room.yaml index bf632c1a..3e88ee0c 100644 --- a/api/client-server/create_room.yaml +++ b/api/client-server/create_room.yaml @@ -150,10 +150,14 @@ paths: properties: type: type: string + description: The type of event to send. state_key: type: string + description: The state_key of the state event. Defaults to an empty string. content: type: object + description: The content of the event. + required: ["type", "content"] preset: type: string enum: ["private_chat", "public_chat", "trusted_private_chat"] diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index 24344116..feabecab 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -37,6 +37,8 @@ Unreleased changes (`#1152 `_). - Mark ``GET /rooms/{roomId}/members`` as requiring authentication (`#1245 `_). + - Describe ``StateEvent`` for ``/createRoom`` + (`#1329 `_). - Changes to the API which will be backwards-compatible for clients: