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

Add room_types and room_type to /publicRooms (#1199)

Browse source 
MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/3827
Incorporates https://github.com/matrix-org/matrix-spec-proposals/pull/3858
This commit is contained in:
Travis Ralston 2022-08-04 17:15:16 -04:00 • committed by GitHub
parent 9506ecea59
commit b14759a27b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 39 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/1199.feature Normal file
View file

@ -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).

5
data/api/client-server/definitions/public_rooms_chunk.yaml
View file

@ -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

3
data/api/client-server/definitions/public_rooms_response.yaml
View file

@ -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",

17
data/api/client-server/list_public_rooms.yaml
View file

@ -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"

1
data/api/client-server/space_hierarchy.yaml
View file

@ -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: |-

20
data/api/server-server/public_rooms.yaml
View file

@ -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",