diff --git a/api/client-server/list_public_rooms.yaml b/api/client-server/list_public_rooms.yaml index 5d09d45a974..88e7445c2b7 100644 --- a/api/client-server/list_public_rooms.yaml +++ b/api/client-server/list_public_rooms.yaml @@ -57,6 +57,7 @@ paths: schema: type: object description: A list of the rooms on the server. + required: ["chunk"] properties: chunk: title: "PublicRoomsChunks" @@ -66,6 +67,7 @@ paths: items: type: object title: "PublicRoomsChunk" + required: ["room_id"] properties: aliases: type: array @@ -180,6 +182,7 @@ paths: filter: type: object title: "Filter" + required: [] description: |- Optional filtering of the returned rooms. properties: @@ -187,7 +190,7 @@ paths: type: string description: |- A string to search for in the room metadata, e.g. name, - topic, canonical alias etc. + topic, canonical alias etc. (Optional). example: |- {"limit": 10, "filter": {"generic_search_term": "foo"}} responses: @@ -196,6 +199,7 @@ paths: schema: type: object description: A list of the rooms on the server. + required: ["chunk"] properties: chunk: title: "PublicRoomsChunks" @@ -205,6 +209,7 @@ paths: items: type: object title: "PublicRoomsChunk" + required: ["room_id"] properties: aliases: type: array