Skip to content

Commit 9f17ab0

Browse files
committed
Use "published room directory" wherever applicable
1 parent 9a0b5ec commit 9f17ab0

File tree

7 files changed

+30
-24
lines changed

7 files changed

+30
-24
lines changed

content/application-service-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -492,10 +492,10 @@ via the query string). It is expected that the application service use
492492
the transactions pushed to it to handle events rather than syncing with
493493
the user implied by `sender_localpart`.
494494
495-
#### Application service room directories
495+
#### Published room directories
496496
497-
Application services can maintain their own room directories for their
498-
defined third-party protocols. These room directories may be accessed by
497+
Application services can maintain their own published room directories for
498+
their defined third-party protocols. These directories may be accessed by
499499
clients through additional parameters on the `/publicRooms`
500500
client-server endpoint.
501501

content/client-server-api/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2846,7 +2846,7 @@ re-invited.
28462846

28472847
{{% http-api spec="client-server" api="banning" %}}
28482848

2849-
### Room directory
2849+
### Published room directory
28502850

28512851
Homeservers MAY publish a room directory to allow users to discover rooms. A room
28522852
can have one of two visibility settings in the directory:

content/server-server-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1048,9 +1048,9 @@ user's Matrix ID and the token delivered when the invite was stored,
10481048
this verification will prove that the `m.room.member` invite event comes
10491049
from the user owning the invited third-party identifier.
10501050

1051-
## Room Directory
1051+
## Published Room Directory
10521052

1053-
To complement the [room directory in the Client-Server API](/client-server-api#room-directory),
1053+
To complement the [room directory in the Client-Server API](/client-server-api#published-room-directory),
10541054
homeservers need a way to query the published rooms of another server.
10551055
This can be done by making a request to the `/publicRooms` endpoint for
10561056
the server the room directory should be retrieved for.

data/api/client-server/appservice_room_directory.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,21 @@
1313
# limitations under the License.
1414
openapi: 3.1.0
1515
info:
16-
title: Matrix Client-Server Application Service Room Directory API
16+
title: Matrix Client-Server Application Service Published Room Directory API
1717
version: 1.0.0
1818
paths:
1919
"/directory/list/appservice/{networkId}/{roomId}":
2020
put:
21-
summary: Updates a room's visibility in the application service's room directory.
22-
description: |-
23-
Updates the visibility of a given room on the application service's room
21+
summary: |-
22+
Updates a room's visibility in the application service's published room
2423
directory.
24+
description: |-
25+
Updates the visibility of a given room in the application service's
26+
published room directory.
2527
26-
This API is similar to the room directory visibility API used by clients
27-
to update the homeserver's more general room directory.
28+
This API is similar to the
29+
[visibility API](/client-server-api#put_matrixclientv3directorylistroomroomid)
30+
used by clients to update the homeserver's more general published room directory.
2831
2932
This API requires the use of an application service access token (`as_token`)
3033
instead of a typical client's access_token. This API cannot be invoked by

data/api/client-server/create_room.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ paths:
8787
- public
8888
- private
8989
description: |-
90-
The room's visibility in the server's [room directory](#room-directory).
90+
The room's visibility in the server's
91+
[published room directory](#published-room-directory).
9192
Defaults to `private`.
9293
room_alias_name:
9394
type: string

data/api/client-server/list_public_rooms.yaml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@
1313
# limitations under the License.
1414
openapi: 3.1.0
1515
info:
16-
title: Matrix Client-Server Room Directory API
16+
title: Matrix Client-Server Published Room Directory API
1717
version: 1.0.0
1818
paths:
1919
"/directory/list/room/{roomId}":
2020
get:
2121
summary: Gets the visibility of a room in the directory
22-
description: Gets the visibility of a given room in the server's room directory.
22+
description: |-
23+
Gets the visibility of a given room in the server's
24+
published room directory.
2325
operationId: getRoomVisibilityOnDirectory
2426
parameters:
2527
- in: path
@@ -63,9 +65,9 @@ paths:
6365
tags:
6466
- Room discovery
6567
put:
66-
summary: Sets the visibility of a room in the room directory
68+
summary: Sets the visibility of a room in the directory
6769
description: |-
68-
Sets the visibility of a given room in the server's room directory.
70+
Sets the visibility of a given room in the server's published room directory.
6971
7072
Servers MAY implement additional access control checks, for instance,
7173
to ensure that a room's visibility can only be changed by the room creator
@@ -99,7 +101,7 @@ paths:
99101
example: {
100102
"visibility": "public"
101103
}
102-
description: The new visibility for the room on the room directory.
104+
description: The new visibility for the room in the published room directory.
103105
required: true
104106
responses:
105107
"200":
@@ -152,8 +154,8 @@ paths:
152154
- in: query
153155
name: server
154156
description: |-
155-
The server to fetch the room directory from. Defaults to the
156-
local server. Case sensitive.
157+
The server to fetch the published room directory from. Defaults
158+
to the local server. Case sensitive.
157159
schema:
158160
type: string
159161
responses:
@@ -180,8 +182,8 @@ paths:
180182
- in: query
181183
name: server
182184
description: |-
183-
The server to fetch the room directory from. Defaults to the
184-
local server. Case sensitive.
185+
The server to fetch the published room directory from. Defaults
186+
to the local server. Case sensitive.
185187
schema:
186188
type: string
187189
requestBody:

data/api/server-server/public_rooms.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
# limitations under the License.
1414
openapi: 3.1.0
1515
info:
16-
title: Matrix Federation Room Directory API
16+
title: Matrix Federation Published Room Directory API
1717
version: 1.0.0
1818
paths:
1919
/publicRooms:
2020
get:
21-
summary: Lists the server's published room directory.
21+
summary: Lists the server's published room directory
2222
description: |-
2323
Lists the server's published room directory.
2424

0 commit comments

Comments
 (0)