summary refs log tree commit diff
path: root/docs/client-server
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-09-03 13:42:56 +0100
committerKegan Dougal <kegan@matrix.org>2014-09-03 13:42:56 +0100
commit56bc57cf5095559cb77f69bffbedafdaf5d7b689 (patch)
tree422c8390937106c8dd9fbefefbc5c39a24ee82ee /docs/client-server
parentapidocs: Tweak join response format. Explicitly state empty JSON objects wher... (diff)
downloadsynapse-56bc57cf5095559cb77f69bffbedafdaf5d7b689.tar.xz
apidocs: Added m.room.name
Diffstat (limited to 'docs/client-server')
-rw-r--r--docs/client-server/swagger_matrix/api-docs-rooms62
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/client-server/swagger_matrix/api-docs-rooms b/docs/client-server/swagger_matrix/api-docs-rooms

index 40bcc45a78..0e1fa452a2 100644 --- a/docs/client-server/swagger_matrix/api-docs-rooms +++ b/docs/client-server/swagger_matrix/api-docs-rooms
@@ -181,6 +181,59 @@ ] }, { + "path": "/rooms/{roomId}/state/m.room.name", + "operations": [ + { + "method": "PUT", + "summary": "Set the name of this room.", + "notes": "Set the name of this room.", + "type": "void", + "nickname": "set_room_name", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "name": "body", + "description": "The name contents", + "required": true, + "type": "RoomName", + "paramType": "body" + }, + { + "name": "roomId", + "description": "The room to set the name of.", + "required": true, + "type": "string", + "paramType": "path" + } + ] + }, + { + "method": "GET", + "summary": "Get the room's name.", + "notes": "", + "type": "RoomName", + "nickname": "get_room_name", + "parameters": [ + { + "name": "roomId", + "description": "The room to get the name of.", + "required": true, + "type": "string", + "paramType": "path" + } + ], + "responseMessages": [ + { + "code": 404, + "message": "Name not found." + } + ] + } + ] + }, + { "path": "/rooms/{roomId}/send/m.room.message.feedback", "operations": [ { @@ -636,6 +689,15 @@ } } }, + "RoomName": { + "id": "RoomName", + "properties": { + "name": { + "type": "string", + "description": "The human-readable name for the room. Can contain spaces." + } + } + }, "Message": { "id": "Message", "properties": {