tileradotorg/synapse
1
0
Fork 0
forked from MirrorHub/synapse
Code Pull requests Activity

apidocs: Tweak join response format. Explicitly state empty JSON objects where they are required by the spec. Mark unimplemented room GET APIs clearly.

Browse source
This commit is contained in:
Kegan Dougal 2014-09-03 13:32:25 +01:00
parent 4b85c5f52c
commit 27cdbf7b94
1 changed files with 35 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
docs/client-server/swagger_matrix/api-docs-rooms
View file

@ -267,6 +267,12 @@
"required": true, "required": true,
"type": "string", "type": "string",
"paramType": "path" "paramType": "path"
},
{
"name": "body",
"required": true,
"type": "JoinRequest",
"paramType": "body"
} }
] ]
} }
@ -291,6 +297,12 @@
"required": true, "required": true,
"type": "string", "type": "string",
"paramType": "path" "paramType": "path"
},
{
"name": "body",
"required": true,
"type": "LeaveRequest",
"paramType": "body"
} }
] ]
} }
@ -424,10 +436,10 @@
"path": "/join/{roomAliasOrId}", "path": "/join/{roomAliasOrId}",
"operations": [ "operations": [
{ {
"method": "PUT", "method": "POST",
"summary": "Join a room via a room alias or room ID.", "summary": "Join a room via a room alias or room ID.",
"notes": "Join a room via a room alias or room ID.", "notes": "Join a room via a room alias or room ID.",
"type": "RoomInfo", "type": "JoinRoomInfo",
"nickname": "join", "nickname": "join",
"consumes": [ "consumes": [
"application/json" "application/json"
@ -574,7 +586,7 @@
{ {
"method": "GET", "method": "GET",
"summary": "Get a list of all the current state events for this room.", "summary": "Get a list of all the current state events for this room.",
"notes": "Get a list of all the current state events for this room.", "notes": "NOT YET IMPLEMENTED.",
"type": "array", "type": "array",
"items": { "items": {
"$ref": "Event" "$ref": "Event"
@ -598,7 +610,7 @@
{ {
"method": "GET", "method": "GET",
"summary": "Get all the current information for this room, including messages and state events.", "summary": "Get all the current information for this room, including messages and state events.",
"notes": "Get all the current information for this room, including messages and state events.", "notes": "NOT YET IMPLEMENTED.",
"type": "InitialSyncRoomData", "type": "InitialSyncRoomData",
"nickname": "get_room_sync_data", "nickname": "get_room_sync_data",
"parameters": [ "parameters": [
@ -662,7 +674,7 @@
"invite", "invite",
"join", "join",
"leave", "leave",
"knock" "ban"
] ]
} }
} }
@ -682,6 +694,16 @@
} }
} }
}, },
"JoinRoomInfo": {
"id": "JoinRoomInfo",
"properties": {
"room_id": {
"type": "string",
"description": "The room ID joined, if joined via a room alias only.",
"required": true
}
}
},
"RoomConfig": { "RoomConfig": {
"id": "RoomConfig", "id": "RoomConfig",
"properties": { "properties": {
@ -840,6 +862,14 @@
} }
} }
}, },
"JoinRequest": {
"id": "JoinRequest",
"properties": {}
},
"LeaveRequest": {
"id": "LeaveRequest",
"properties": {}
},
"BanRequest": { "BanRequest": {
"id": "BanRequest", "id": "BanRequest",
"properties": { "properties": {