From 56bc57cf5095559cb77f69bffbedafdaf5d7b689 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Wed, 3 Sep 2014 13:42:56 +0100
Subject: [PATCH] apidocs: Added m.room.name
---
.../swagger_matrix/api-docs-rooms | 62 +++++++++++++++++++
1 file changed, 62 insertions(+)
diff --git a/docs/client-server/swagger_matrix/api-docs-rooms b/docs/client-server/swagger_matrix/api-docs-rooms
index 40bcc45a7..0e1fa452a 100644
--- a/docs/client-server/swagger_matrix/api-docs-rooms
+++ b/docs/client-server/swagger_matrix/api-docs-rooms
@@ -180,6 +180,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": {