Skip to content
Snippets Groups Projects
Commit 27cdbf7b authored by Kegan Dougal's avatar Kegan Dougal
Browse files

apidocs: Tweak join response format. Explicitly state empty JSON objects where...

apidocs: Tweak join response format. Explicitly state empty JSON objects where they are required by the spec. Mark unimplemented room GET APIs clearly.
parent 4b85c5f5
No related branches found
No related tags found
No related merge requests found
......@@ -267,6 +267,12 @@
"required": true,
"type": "string",
"paramType": "path"
},
{
"name": "body",
"required": true,
"type": "JoinRequest",
"paramType": "body"
}
]
}
......@@ -291,6 +297,12 @@
"required": true,
"type": "string",
"paramType": "path"
},
{
"name": "body",
"required": true,
"type": "LeaveRequest",
"paramType": "body"
}
]
}
......@@ -424,10 +436,10 @@
"path": "/join/{roomAliasOrId}",
"operations": [
{
"method": "PUT",
"method": "POST",
"summary": "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",
"consumes": [
"application/json"
......@@ -574,7 +586,7 @@
{
"method": "GET",
"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",
"items": {
"$ref": "Event"
......@@ -598,7 +610,7 @@
{
"method": "GET",
"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",
"nickname": "get_room_sync_data",
"parameters": [
......@@ -662,7 +674,7 @@
"invite",
"join",
"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": {
"id": "RoomConfig",
"properties": {
......@@ -840,6 +862,14 @@
}
}
},
"JoinRequest": {
"id": "JoinRequest",
"properties": {}
},
"LeaveRequest": {
"id": "LeaveRequest",
"properties": {}
},
"BanRequest": {
"id": "BanRequest",
"properties": {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment