Spec PUT /directory/list (SPEC-102)

[matrixbot]

PUT /_matrix/client/r0/directory/list/room/<room_id> is used to manage the visibility of rooms in the room list, but this is undocumented

(Imported from https://matrix.org/jira/browse/SPEC-102)

(Reported by @ara4n)

[matrixbot]

Jira watchers: @ara4n @richvdh

[matrixbot]

It's the visibility flag on createRoom, but presumably we are looking for a way to change it post-hoc?

-- @richvdh

[matrixbot]

we have /directory/list, but that isn't specced. Updating the summary accordingly.

-- @richvdh

[gergelypolonkai]

Would this mean that this would change the state of the room? If so, why do we need a separate API for this? It's pretty much the same functionality as PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey} under a different name.

Also, considering it has a reason, if there's a PUT, shouldn't we add DELETE, too?

[turt2live]

The room directory is intenteded to be an isolated component of the homeserver, such that the "core" homeserver can work without a room directory, and a room directory can live independently of the core homeserver.

[gergelypolonkai]

Ah, OK. So when I update a room state with join_rules, it will update the room directory, but when I update the room directory, it won’t update the rooms? Sounds a bit strange to me…

[turt2live]

Updating join_rules doesn't update the directory directly. The directory pulls this information from the room.

[jevolk]

This endpoint shouldn't exist.

@gergelypolonkai appears to be correct. The client's conveys what it wants by submitting the state event to the room's state endpoint. The client's responsibilities end there. If another operation like this takes place it's only conveying redundant information. In this case, the server has to figure out both times if the client is permitted to perform the operation and the client has to handle interaction and errors in both places.

What @turt2live is describing is at best an operation the server should be responsible for, and at worst an opaque implementation detail for the client-server/directory-server to work out internally. Furthermore, if directory listing details need to be conveyed, that can be done either in the event's content or with another event type.

Either way it means this endpoint shouldn't exist.

[richvdh]

fixed by #1141 thanks to @turt2live !