wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Formatting and remove DELETE /directory/list

Browse source 
Signed-off-by: Travis Ralston <travpc@gmail.com>
This commit is contained in:
Travis Ralston 2018-03-06 10:05:32 -07:00
parent 5cbfa73fe4
commit d88a1308c2
1 changed files with 11 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

52
api/client-server/list_public_rooms.yaml
View file

@ -50,15 +50,15 @@ paths:
description: The visibility of the room in the directory. description: The visibility of the room in the directory.
examples: examples:
application/json: { application/json: {
"visibility": "public" "visibility": "public"
} }
404: 404:
description: The room is not known to the server description: The room is not known to the server
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",
"error": "Room not found" "error": "Room not found"
} }
put: put:
summary: Sets the visibility of a room in the room directory summary: Sets the visibility of a room in the room directory
description: |- description: |-
@ -93,50 +93,20 @@ paths:
The new visibility setting for the room. The new visibility setting for the room.
Defaults to 'public'. Defaults to 'public'.
example: { example: {
"visibility": "public" "visibility": "public"
} }
responses: responses:
200: 200:
description: The visibility was updated, or no change was needed. description: The visibility was updated, or no change was needed.
examples: examples:
application/json: { application/json: {}
}
404: 404:
description: The room is not known to the server description: The room is not known to the server
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",
"error": "Room not found" "error": "Room not found"
} }
delete:
summary: Sets a room to be private on the room directory
description: |-
Updates the visibility of a room to be private on the server's room
directory. This is the same as using the PUT operation with a private
as the visibility.
operationId: setRoomPrivateOnDirectory
security:
- accessToken: []
parameters:
- in: path
type: string
name: roomId
description: The room ID.
required: true
x-example: "!curbf:matrix.org"
responses:
200:
description: The visibility was updated, or no change was needed.
examples:
application/json: {
}
404:
description: The room is not known to the server
examples:
application/json: {
"errcode": "M_NOT_FOUND",
"error": "Room not found"
}
"/publicRooms": "/publicRooms":
get: get:
summary: Lists the public rooms on the server. summary: Lists the public rooms on the server.