Spec /directory/list #1141

turt2live · 2018-03-03T21:48:09Z

Adds matrix-org#417 Signed-off-by: Travis Ralston <travpc@gmail.com>

Signed-off-by: Travis Ralston <travpc@gmail.com>

richvdh · 2018-03-06T12:30:28Z

changelogs/client_server.rst

@@ -23,6 +23,8 @@ Unreleased changes
    (`#1137 <https://github.com/matrix-org/matrix-doc/pull/1137>`_).
  - Clarify that ``m.tag`` ordering is done with numbers, not strings
    (`#1139 <https://github.com/matrix-org/matrix-doc/pull/1139>`_).
+  - Add the room visibility options for the room directory


this should be under "Changes to the API which will be backwards-compatible for clients".

richvdh · 2018-03-06T12:40:21Z

api/client-server/list_public_rooms.yaml

+        Gets the visibility of a given room on the server's public room directory.
+      operationId: getRoomVisibilityOnDirectory
+      security:
+        - accessToken: []


synapse appears happy without an access token. I think this is deliberate?

It makes sense to be deliberate - let's go with that.

richvdh · 2018-03-06T12:42:22Z

changelogs/client_server.rst

@@ -23,6 +23,8 @@ Unreleased changes
    (`#1137 <https://github.com/matrix-org/matrix-doc/pull/1137>`_).
  - Clarify that ``m.tag`` ordering is done with numbers, not strings
    (`#1139 <https://github.com/matrix-org/matrix-doc/pull/1139>`_).
+  - Add the room visibility options for the room directory
+    (`#1141 <https://github.com/matrix-org/matrix-doc/pull/1141`_).


this has lost its closing >

richvdh · 2018-03-06T12:43:36Z

api/client-server/list_public_rooms.yaml

+          description: The room is not known to the server
+          examples:
+            application/json: {
+                  "errcode": "M_UNKNOWN",


this probably ought to be M_NOT_FOUND, and we should treat the fact synapse returns M_UNKNOWN as a bug.

richvdh · 2018-03-06T12:45:05Z

api/client-server/list_public_rooms.yaml

+                  "error": "Room not found"
+              }
+    delete:
+      summary: Sets a room to be private on the room directory


how is this different from PUT private?

"synapse" is my only answer.

richvdh · 2018-03-06T12:47:17Z

api/client-server/list_public_rooms.yaml

+      summary: Sets the visibility of a room in the room directory
+      description: |-
+        Sets the visibility of a given room in the server's public room
+        directory.


Could we clarify who is allowed to call this? Is it controlled by power_levels or a server admin flag? If the latter you could take inspiration from https://matrix.org/docs/spec/client_server/unstable.html#delete-matrix-client-r0-directory-room-roomalias for some wording

I took a look at what synapse does, and it seems to require one of the conditions to be met:

The user isn't spamming (as far as the anti-scam stuff is concerned)

The user is a server admin

The user is in the room and can change the m.room.aliases event (moderator)

Because of the above, inspiration has been taken from the alias delete route.

richvdh · 2018-03-06T12:48:47Z

api/client-server/list_public_rooms.yaml

+          examples: 
+            application/json: {
+                  "visibility": "public"
+              }


indentation is weird here. this should line up with "application/json", and the content is over-indented. Likewise below.

Both are indented according to a random sampling of other docs in the area.

I'm pretty sure if it were lined up then yaml will think it's an object, not a string.

It is an object. Please don't ask me what happens if you want to give an example which isn't application/json.

See 820704a for some background here. The reason for the odd indentation everywhere else is that they were turned from a string into an object with some hacky perl which didn't bother to realign the closing ".

Alright. I don't have a way to verify the fix at the moment (matrix-doc barfs on windows and I'm not really able to justify the time in fighting it at the moment), but I'll make the change.

Signed-off-by: Travis Ralston <travpc@gmail.com>

* 404 for room not found instead of 400 * GET doesn't require an access token * PUT (and therefore DELETE) can have it's own access control checks * DELETE is implemented because of synapse Signed-off-by: Travis Ralston <travpc@gmail.com>

richvdh · 2018-03-06T17:00:23Z

api/client-server/list_public_rooms.yaml

+      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


ok, I'm in danger of channeling jzk, but I feel like this has no justification in existing. If we can remove the listing with a PUT, then everything should be using that, and we should treat failure to do so as a bug.

It looks like Riot doesn't use it anyways. I've removed it - some sort of transition period should probably still be added to remove it from synapse.

Signed-off-by: Travis Ralston <travpc@gmail.com>

richvdh · 2018-03-06T17:16:15Z

thanks!

turt2live added 2 commits March 3, 2018 14:46

Spec /directory/list

595667d

Adds matrix-org#417 Signed-off-by: Travis Ralston <travpc@gmail.com>

Add /directory/list to changelog

b41bd96

Signed-off-by: Travis Ralston <travpc@gmail.com>

turt2live mentioned this pull request Mar 5, 2018

Directory-service "list" verb (SPEC-71) #476

Closed

Merge branch 'master' into travis/spec-directory-list

e4f7ba7

richvdh requested changes Mar 6, 2018

View reviewed changes

turt2live mentioned this pull request Mar 6, 2018

/directory/list APIs should return 404 not 400 for room not found matrix-org/synapse#2952

Closed

turt2live added 2 commits March 6, 2018 08:50

Move /directory/list changelog entry

709fca8

Signed-off-by: Travis Ralston <travpc@gmail.com>

Improve documentation of /directory/list

5cbfa73

* 404 for room not found instead of 400 * GET doesn't require an access token * PUT (and therefore DELETE) can have it's own access control checks * DELETE is implemented because of synapse Signed-off-by: Travis Ralston <travpc@gmail.com>

richvdh reviewed Mar 6, 2018

View reviewed changes

Formatting and remove DELETE /directory/list

d88a130

Signed-off-by: Travis Ralston <travpc@gmail.com>

turt2live mentioned this pull request Mar 6, 2018

Remove DELETE /directory/list/room/{roomId} matrix-org/synapse#2953

Open

richvdh approved these changes Mar 6, 2018

View reviewed changes

richvdh merged commit b1550ea into matrix-org:master Mar 6, 2018

turt2live deleted the travis/spec-directory-list branch March 6, 2018 17:16

richvdh mentioned this pull request Mar 6, 2018

Spec PUT /directory/list (SPEC-102) #417

Closed

richvdh mentioned this pull request Feb 10, 2020

synapse implements an unspecced DELETE /_matrix/client/r0/directory/list/room/{roomId} API matrix-org/synapse#6885

Closed

matrixbot mentioned this pull request Dec 21, 2023

Remove DELETE /directory/list/room/{roomId} element-hq/synapse#2953

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spec /directory/list #1141

Spec /directory/list #1141

turt2live commented Mar 3, 2018

richvdh Mar 6, 2018

richvdh Mar 6, 2018

turt2live Mar 6, 2018

richvdh Mar 6, 2018

richvdh Mar 6, 2018

richvdh Mar 6, 2018

turt2live Mar 6, 2018

richvdh Mar 6, 2018

turt2live Mar 6, 2018

richvdh Mar 6, 2018

turt2live Mar 6, 2018

richvdh Mar 6, 2018

richvdh Mar 6, 2018

turt2live Mar 6, 2018

richvdh Mar 6, 2018

turt2live Mar 6, 2018

richvdh commented Mar 6, 2018

Spec /directory/list #1141

Spec /directory/list #1141

Conversation

turt2live commented Mar 3, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

richvdh commented Mar 6, 2018