Add room_types and room_type to /publicRooms

MSC: matrix-org/matrix-spec-proposals#3827 Incorporates matrix-org/matrix-spec-proposals#3858
matrix-org · Aug 3, 2022 · 7c833d5 · 7c833d5
1 parent b36d4ef
commit 7c833d5
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 8 deletions.
diff --git a/changelogs/client_server/newsfragments/1199.feature b/changelogs/client_server/newsfragments/1199.feature
@@ -0,0 +1 @@
+Add `room_types` filter and `room_type` response to `/publicRooms`, as per [MSC3827](https://github.com/matrix-org/matrix-spec-proposals/pull/3827).
diff --git a/data/api/client-server/definitions/public_rooms_chunk.yaml b/data/api/client-server/definitions/public_rooms_chunk.yaml
@@ -57,6 +57,11 @@ properties:
       The room's join rule. When not present, the room is assumed to
       be `public`.
     example: "public"
+  room_type:
+    type: string
+    x-addedInMatrixVersion: "1.4"
+    description: |-
+      The `type` of room (from [`m.room.create`](/client-server-api/#mroomcreate)), if any.
 required:
   - room_id
   - num_joined_members

diff --git a/data/api/client-server/definitions/public_rooms_response.yaml b/data/api/client-server/definitions/public_rooms_response.yaml
@@ -62,7 +62,8 @@ example: {
       "room_id": "!ol19s:bleecker.street",
       "topic": "Tasty tasty cheese",
       "world_readable": true,
-      "join_rule": "public"
+      "join_rule": "public",
+      "room_type": "m.space"
     }
   ],
   "next_batch": "p190q",

diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml
@@ -198,8 +198,18 @@ paths:
                     generic_search_term:
                       type: string
                       description: |-
-                        A string to search for in the room metadata, e.g. name,
-                        topic, canonical alias etc. (Optional).
+                        An optional string to search for in the room metadata, e.g. name,
+                        topic, canonical alias, etc.
+                    room_types:
+                      type: array
+                      x-addedInMatrixVersion: "1.4"
+                      items:
+                        type: string
+                      description: |-
+                        An optional list of [room types](/client-server-api/#types) to search
+                        for. To include rooms without a room type, specify `null` within this
+                        list. When not specified, all applicable rooms (regardless of type)
+                        are returned.
               include_all_networks:
                 type: boolean
                 description: |-
@@ -215,7 +225,8 @@ paths:
             example: {
               "limit": 10,
               "filter": {
-                "generic_search_term": "foo"
+                "generic_search_term": "foo",
+                "room_types": [null, "m.space"]
               },
               "include_all_networks": false,
               "third_party_instance_id": "irc"

diff --git a/data/api/client-server/space_hierarchy.yaml b/data/api/client-server/space_hierarchy.yaml
@@ -129,6 +129,7 @@ paths:
                     - type: object
                       title: ChildRoomsChunk
                       properties:
+                        # Override x-addedInMatrixVersion for room_type (this endpoint had it first)
                         room_type:
                           type: string
                           description: |-

diff --git a/data/api/server-server/public_rooms.yaml b/data/api/server-server/public_rooms.yaml
@@ -110,8 +110,18 @@ paths:
                     generic_search_term:
                       type: string
                       description: |-
-                        A string to search for in the room metadata, e.g. name,
-                        topic, canonical alias etc. (Optional).
+                        An optional string to search for in the room metadata, e.g. name,
+                        topic, canonical alias, etc.
+                    room_types:
+                      type: array
+                      x-addedInMatrixVersion: "1.4"
+                      items:
+                        type: string
+                      description: |-
+                        An optional list of [room types](/client-server-api/#types) to search
+                        for. To include rooms without a room type, specify `null` within this
+                        list. When not specified, all applicable rooms (regardless of type)
+                        are returned.
               include_all_networks:
                 type: boolean
                 description: |-
@@ -127,7 +137,8 @@ paths:
             example: {
               "limit": 10,
               "filter": {
-                "generic_search_term": "foo"
+                "generic_search_term": "foo",
+                "room_types": [null, "m.space"]
               },
               "include_all_networks": false,
               "third_party_instance_id": "irc"
@@ -185,7 +196,8 @@ paths:
                   "room_id": "!ol19s:bleecker.street",
                   "topic": "Tasty tasty cheese",
                   "world_readable": true,
-                  "join_rule": "public"
+                  "join_rule": "public",
+                  "room_type": "m.space"
                 }
               ],
               "next_batch": "p190q",