diff --git a/content/application-service-api.md b/content/application-service-api.md index 2882f3d9..4c1ada48 100644 --- a/content/application-service-api.md +++ b/content/application-service-api.md @@ -492,10 +492,10 @@ via the query string). It is expected that the application service use the transactions pushed to it to handle events rather than syncing with the user implied by `sender_localpart`. -#### Application service room directories +#### Published room directories -Application services can maintain their own room directories for their -defined third-party protocols. These room directories may be accessed by +Application services can maintain their own published room directories for +their defined third-party protocols. These directories may be accessed by clients through additional parameters on the `/publicRooms` client-server endpoint. diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index c6d52972..d4dfd561 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -2846,7 +2846,7 @@ re-invited. {{% http-api spec="client-server" api="banning" %}} -### Room directory +### Published room directory Homeservers MAY publish a room directory to allow users to discover rooms. A room can have one of two visibility settings in the directory: diff --git a/content/server-server-api.md b/content/server-server-api.md index d9bd02e7..2c52c0e3 100644 --- a/content/server-server-api.md +++ b/content/server-server-api.md @@ -1048,9 +1048,9 @@ user's Matrix ID and the token delivered when the invite was stored, this verification will prove that the `m.room.member` invite event comes from the user owning the invited third-party identifier. -## Room Directory +## Published Room Directory -To complement the [room directory in the Client-Server API](/client-server-api#room-directory), +To complement the [room directory in the Client-Server API](/client-server-api#published-room-directory), homeservers need a way to query the published rooms of another server. This can be done by making a request to the `/publicRooms` endpoint for the server the room directory should be retrieved for. diff --git a/data/api/client-server/appservice_room_directory.yaml b/data/api/client-server/appservice_room_directory.yaml index b4ec42f0..0443dad2 100644 --- a/data/api/client-server/appservice_room_directory.yaml +++ b/data/api/client-server/appservice_room_directory.yaml @@ -13,18 +13,21 @@ # limitations under the License. openapi: 3.1.0 info: - title: Matrix Client-Server Application Service Room Directory API + title: Matrix Client-Server Application Service Published Room Directory API version: 1.0.0 paths: "/directory/list/appservice/{networkId}/{roomId}": put: - summary: Updates a room's visibility in the application service's room directory. - description: |- - Updates the visibility of a given room on the application service's room + summary: |- + Updates a room's visibility in the application service's published room directory. + description: |- + Updates the visibility of a given room in the application service's + published room directory. - This API is similar to the room directory visibility API used by clients - to update the homeserver's more general room directory. + This API is similar to the + [visibility API](/client-server-api#put_matrixclientv3directorylistroomroomid) + used by clients to update the homeserver's more general published room directory. This API requires the use of an application service access token (`as_token`) instead of a typical client's access_token. This API cannot be invoked by diff --git a/data/api/client-server/create_room.yaml b/data/api/client-server/create_room.yaml index f60f54d0..73bd2bfa 100644 --- a/data/api/client-server/create_room.yaml +++ b/data/api/client-server/create_room.yaml @@ -87,7 +87,8 @@ paths: - public - private description: |- - The room's visibility in the server's [room directory](#room-directory). + The room's visibility in the server's + [published room directory](#published-room-directory). Defaults to `private`. room_alias_name: type: string diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml index 7b6adc00..ef71ca63 100644 --- a/data/api/client-server/list_public_rooms.yaml +++ b/data/api/client-server/list_public_rooms.yaml @@ -13,13 +13,15 @@ # limitations under the License. openapi: 3.1.0 info: - title: Matrix Client-Server Room Directory API + title: Matrix Client-Server Published Room Directory API version: 1.0.0 paths: "/directory/list/room/{roomId}": get: summary: Gets the visibility of a room in the directory - description: Gets the visibility of a given room in the server's room directory. + description: |- + Gets the visibility of a given room in the server's + published room directory. operationId: getRoomVisibilityOnDirectory parameters: - in: path @@ -63,9 +65,9 @@ paths: tags: - Room discovery put: - summary: Sets the visibility of a room in the room directory + summary: Sets the visibility of a room in the directory description: |- - Sets the visibility of a given room in the server's room directory. + Sets the visibility of a given room in the server's published room directory. Servers MAY implement additional access control checks, for instance, to ensure that a room's visibility can only be changed by the room creator @@ -99,7 +101,7 @@ paths: example: { "visibility": "public" } - description: The new visibility for the room on the room directory. + description: The new visibility for the room in the published room directory. required: true responses: "200": @@ -152,8 +154,8 @@ paths: - in: query name: server description: |- - The server to fetch the room directory from. Defaults to the - local server. Case sensitive. + The server to fetch the published room directory from. Defaults + to the local server. Case sensitive. schema: type: string responses: @@ -180,8 +182,8 @@ paths: - in: query name: server description: |- - The server to fetch the room directory from. Defaults to the - local server. Case sensitive. + The server to fetch the published room directory from. Defaults + to the local server. Case sensitive. schema: type: string requestBody: diff --git a/data/api/server-server/public_rooms.yaml b/data/api/server-server/public_rooms.yaml index 13931f98..8beaecb2 100644 --- a/data/api/server-server/public_rooms.yaml +++ b/data/api/server-server/public_rooms.yaml @@ -13,12 +13,12 @@ # limitations under the License. openapi: 3.1.0 info: - title: Matrix Federation Room Directory API + title: Matrix Federation Published Room Directory API version: 1.0.0 paths: /publicRooms: get: - summary: Lists the server's published room directory. + summary: Lists the server's published room directory description: |- Lists the server's published room directory.