From 5539251d82ff81eaea443141f23ea69936eb9c40 Mon Sep 17 00:00:00 2001
From: Kegan Dougal <kegan@matrix.org>
Date: Tue, 2 Sep 2014 11:53:53 +0100
Subject: Updated API docs with new keys on /createRoom and new API
 /rooms/$roomid/ban

---
 docs/client-server/swagger_matrix/api-docs-rooms | 54 ++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

(limited to 'docs/client-server/swagger_matrix/api-docs-rooms')

diff --git a/docs/client-server/swagger_matrix/api-docs-rooms b/docs/client-server/swagger_matrix/api-docs-rooms
index 7d3341f097..0a8bb3c2a5 100644
--- a/docs/client-server/swagger_matrix/api-docs-rooms
+++ b/docs/client-server/swagger_matrix/api-docs-rooms
@@ -296,6 +296,37 @@
         }  
       ]
     },
+    {
+      "path": "/rooms/{roomId}/ban",
+      "operations": [
+        {
+          "method": "POST",
+          "summary": "Ban a user in the room.",
+          "notes": "This operation can also be done as a PUT by suffixing /{txnId}. The caller must have the required power level to do this operation.",
+          "type": "void",
+          "nickname": "ban",
+          "consumes": [
+            "application/json"
+          ],
+          "parameters": [
+            {
+              "name": "roomId",
+              "description": "The room which has the user to ban.",
+              "required": true,
+              "type": "string",
+              "paramType": "path"
+            },
+            {
+              "name": "body",
+              "description": "The user to ban.",
+              "required": true,
+              "type": "BanRequest",
+              "paramType": "body"
+            }
+          ]
+        }  
+      ]
+    },
     {
       "path": "/rooms/{roomId}/state/m.room.member/{userId}",
       "operations": [
@@ -657,6 +688,16 @@
           "type": "string",
           "description": "The alias to give the new room.",
           "required": false
+        },
+        "name": {
+          "type": "string",
+          "description": "Sets the name of the room. Send a m.room.name event after creating the room with the 'name' key specified.",
+          "required": false
+        },
+        "topic": {
+          "type": "string",
+          "description": "Sets the topic for the room. Send a m.room.topic event after creating the room with the 'topic' key specified.",
+          "required": false
         }
       }
     },
@@ -789,6 +830,19 @@
         }
       }
     },
+    "BanRequest": {
+      "id": "BanRequest",
+      "properties": {
+        "user_id": {
+          "type": "string",
+          "description": "The fully-qualified user ID."
+        },
+        "reason": {
+          "type": "string",
+          "description": "The reason for the ban."
+        }
+      }
+    },
     "InitialSyncRoomData": {
       "id": "InitialSyncRoomData",
       "properties": {
-- 
cgit 1.4.1