From 4806deacb3704af6dfddf2de32ca2c7adc2dda4b Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Fri, 19 Dec 2014 16:37:42 +0000 Subject: [PATCH] Add information on m.room.power_levels --- swagger/client-server/api-docs-rooms | 86 ++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) diff --git a/swagger/client-server/api-docs-rooms b/swagger/client-server/api-docs-rooms index 0ee1228c..9a4ddbe8 100644 --- a/swagger/client-server/api-docs-rooms +++ b/swagger/client-server/api-docs-rooms @@ -233,6 +233,37 @@ } ] }, + { + "path": "/rooms/{roomId}/state/m.room.power_levels", + "operations": [ + { + "method": "PUT", + "summary": "Set the power levels for this room.", + "notes": "This has to be set atomically. The levels set will clobber what was previously there.", + "type": "void", + "nickname": "set_room_power_levels", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "name": "body", + "description": "The power levels", + "required": true, + "type": "RoomPowerLevels", + "paramType": "body" + }, + { + "name": "roomId", + "description": "The room to set the power levels for.", + "required": true, + "type": "string", + "paramType": "path" + } + ] + } + ] + }, { "path": "/rooms/{roomId}/send/m.room.message.feedback", "operations": [ @@ -732,6 +763,61 @@ } } }, + "UserPowerLevels": { + "id": "UserPowerLevels", + "properties": { + "__user_id__": { + "type": "integer", + "description": "The power level for __user_id__" + } + } + }, + "EventPowerLevels": { + "id": "UserPowerLevels", + "properties": { + "__event_type__": { + "type": "integer", + "description": "The power level required in order to send __event_type__ events." + } + } + }, + "RoomPowerLevels": { + "id": "RoomPowerLevels", + "properties": { + "ban": { + "type": "integer", + "description": "The minimum level required in order to ban someone." + }, + "kick": { + "type": "integer", + "description": "The minimum level required in order to kick someone." + }, + "redact": { + "type": "integer", + "description": "The minimum level required in order to redact a message." + }, + "users_default": { + "type": "integer", + "description": "The default power level of a user who is not in the 'users' list." + }, + "state_default": { + "type": "integer", + "description": "The default power level required in order to send state events." + }, + "events_default": { + "type": "integer", + "description": "The default power level required in order to send non-state events." + }, + "users": { + "type": "UserPowerLevels", + "description": "Mappings of user ID to power level." + }, + "events": { + "type": "EventPowerLevels", + "description": "Mappings of event type to power level." + } + } + }, "Message": { "id": "Message", "properties": {