Add room_types
and room_type
to /publicRooms
(#1199)
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:
parent
9506ecea59
commit
b14759a27b
6 changed files with 39 additions and 8 deletions
1
changelogs/client_server/newsfragments/1199.feature
Normal file
1
changelogs/client_server/newsfragments/1199.feature
Normal 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).
|
|
@ -57,6 +57,11 @@ properties:
|
||||||
The room's join rule. When not present, the room is assumed to
|
The room's join rule. When not present, the room is assumed to
|
||||||
be `public`.
|
be `public`.
|
||||||
example: "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:
|
required:
|
||||||
- room_id
|
- room_id
|
||||||
- num_joined_members
|
- num_joined_members
|
||||||
|
|
|
@ -62,7 +62,8 @@ example: {
|
||||||
"room_id": "!ol19s:bleecker.street",
|
"room_id": "!ol19s:bleecker.street",
|
||||||
"topic": "Tasty tasty cheese",
|
"topic": "Tasty tasty cheese",
|
||||||
"world_readable": true,
|
"world_readable": true,
|
||||||
"join_rule": "public"
|
"join_rule": "public",
|
||||||
|
"room_type": "m.space"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"next_batch": "p190q",
|
"next_batch": "p190q",
|
||||||
|
|
|
@ -198,8 +198,18 @@ paths:
|
||||||
generic_search_term:
|
generic_search_term:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
A string to search for in the room metadata, e.g. name,
|
An optional string to search for in the room metadata, e.g. name,
|
||||||
topic, canonical alias etc. (Optional).
|
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:
|
include_all_networks:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -215,7 +225,8 @@ paths:
|
||||||
example: {
|
example: {
|
||||||
"limit": 10,
|
"limit": 10,
|
||||||
"filter": {
|
"filter": {
|
||||||
"generic_search_term": "foo"
|
"generic_search_term": "foo",
|
||||||
|
"room_types": [null, "m.space"]
|
||||||
},
|
},
|
||||||
"include_all_networks": false,
|
"include_all_networks": false,
|
||||||
"third_party_instance_id": "irc"
|
"third_party_instance_id": "irc"
|
||||||
|
|
|
@ -129,6 +129,7 @@ paths:
|
||||||
- type: object
|
- type: object
|
||||||
title: ChildRoomsChunk
|
title: ChildRoomsChunk
|
||||||
properties:
|
properties:
|
||||||
|
# Override x-addedInMatrixVersion for room_type (this endpoint had it first)
|
||||||
room_type:
|
room_type:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
|
|
|
@ -110,8 +110,18 @@ paths:
|
||||||
generic_search_term:
|
generic_search_term:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
A string to search for in the room metadata, e.g. name,
|
An optional string to search for in the room metadata, e.g. name,
|
||||||
topic, canonical alias etc. (Optional).
|
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:
|
include_all_networks:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |-
|
description: |-
|
||||||
|
@ -127,7 +137,8 @@ paths:
|
||||||
example: {
|
example: {
|
||||||
"limit": 10,
|
"limit": 10,
|
||||||
"filter": {
|
"filter": {
|
||||||
"generic_search_term": "foo"
|
"generic_search_term": "foo",
|
||||||
|
"room_types": [null, "m.space"]
|
||||||
},
|
},
|
||||||
"include_all_networks": false,
|
"include_all_networks": false,
|
||||||
"third_party_instance_id": "irc"
|
"third_party_instance_id": "irc"
|
||||||
|
@ -185,7 +196,8 @@ paths:
|
||||||
"room_id": "!ol19s:bleecker.street",
|
"room_id": "!ol19s:bleecker.street",
|
||||||
"topic": "Tasty tasty cheese",
|
"topic": "Tasty tasty cheese",
|
||||||
"world_readable": true,
|
"world_readable": true,
|
||||||
"join_rule": "public"
|
"join_rule": "public",
|
||||||
|
"room_type": "m.space"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"next_batch": "p190q",
|
"next_batch": "p190q",
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue