Merge 201942ce44 into 6897b6bfd5

changelogs/client_server/newsfragments/2392.feature

@@ -0,0 +1 @@
+The room directory now returns rooms in a server-defined order rather than largest first, as per [MSC4423](https://github.com/matrix-org/matrix-spec-proposals/pull/4423).

changelogs/server_server/newsfragments/2392.feature

@@ -0,0 +1 @@
+The room directory now returns rooms in a server-defined order rather than largest first, as per [MSC4423](https://github.com/matrix-org/matrix-spec-proposals/pull/4423).

data/api/client-server/list_public_rooms.yaml

@@ -137,8 +137,12 @@ paths:
       description: |-
         Lists a server's published room directory.
 
-        This API returns paginated responses. The rooms are ordered by the number
+        This API returns paginated responses.
-        of joined members, with the largest rooms first.
+
+        {{% changed-in v="1.19" %}} The server determines the order of the rooms
+        returned by this endpoint. Previously, rooms were ordered with the largest
+        joined member count first. Continuing to order by largest first or another
+        stable order is recommended.
       operationId: getPublicRooms
       parameters:
         - in: query
@@ -177,8 +181,12 @@ paths:
       description: |-
         Lists a server's published room directory with an optional filter.
 
-        This API returns paginated responses. The rooms are ordered by the number
+        This API returns paginated responses.
-        of joined members, with the largest rooms first.
+
+        {{% changed-in v="1.19" %}} The server determines the order of the rooms
+        returned by this endpoint. Previously, rooms were ordered with the largest
+        joined member count first. Continuing to order by largest first or another
+        stable order is recommended.
       operationId: queryPublicRooms
       security:
         - accessTokenQuery: []

data/api/server-server/public_rooms.yaml

@@ -22,8 +22,12 @@ paths:
       description: |-
         Lists the server's published room directory.
 
-        This API returns paginated responses. The rooms are ordered by the number
+        This API returns paginated responses.
-        of joined members, with the largest rooms first.
+
+        {{% changed-in v="1.19" %}} The server determines the order of the rooms
+        returned by this endpoint. Previously, rooms were ordered with the largest
+        joined member count first. Continuing to order by largest first or another
+        stable order is recommended.
 
         This SHOULD not return rooms that are listed on another homeserver's directory,
         just those listed on the receiving homeserver's directory.
@@ -76,8 +80,12 @@ paths:
       description: |-
         Lists the server's published room directory with an optional filter.
 
-        This API returns paginated responses. The rooms are ordered by the number
+        This API returns paginated responses.
-        of joined members, with the largest rooms first.
+
+        {{% changed-in v="1.19" %}} The server determines the order of the rooms
+        returned by this endpoint. Previously, rooms were ordered with the largest
+        joined member count first. Continuing to order by largest first or another
+        stable order is recommended.
       operationId: queryPublicRooms
       security:
         - signedRequest: []