mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-04-13 22:54:10 +02:00
Use "published room directory" wherever applicable
This commit is contained in:
parent
9a0b5ecb11
commit
9f17ab069b
|
|
@ -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 transactions pushed to it to handle events rather than syncing with
|
||||||
the user implied by `sender_localpart`.
|
the user implied by `sender_localpart`.
|
||||||
|
|
||||||
#### Application service room directories
|
#### Published room directories
|
||||||
|
|
||||||
Application services can maintain their own room directories for their
|
Application services can maintain their own published room directories for
|
||||||
defined third-party protocols. These room directories may be accessed by
|
their defined third-party protocols. These directories may be accessed by
|
||||||
clients through additional parameters on the `/publicRooms`
|
clients through additional parameters on the `/publicRooms`
|
||||||
client-server endpoint.
|
client-server endpoint.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2846,7 +2846,7 @@ re-invited.
|
||||||
|
|
||||||
{{% http-api spec="client-server" api="banning" %}}
|
{{% 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
|
Homeservers MAY publish a room directory to allow users to discover rooms. A room
|
||||||
can have one of two visibility settings in the directory:
|
can have one of two visibility settings in the directory:
|
||||||
|
|
|
||||||
|
|
@ -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
|
this verification will prove that the `m.room.member` invite event comes
|
||||||
from the user owning the invited third-party identifier.
|
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.
|
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
|
This can be done by making a request to the `/publicRooms` endpoint for
|
||||||
the server the room directory should be retrieved for.
|
the server the room directory should be retrieved for.
|
||||||
|
|
|
||||||
|
|
@ -13,18 +13,21 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
openapi: 3.1.0
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Matrix Client-Server Application Service Room Directory API
|
title: Matrix Client-Server Application Service Published Room Directory API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
paths:
|
paths:
|
||||||
"/directory/list/appservice/{networkId}/{roomId}":
|
"/directory/list/appservice/{networkId}/{roomId}":
|
||||||
put:
|
put:
|
||||||
summary: Updates a room's visibility in the application service's room directory.
|
summary: |-
|
||||||
description: |-
|
Updates a room's visibility in the application service's published room
|
||||||
Updates the visibility of a given room on the application service's room
|
|
||||||
directory.
|
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
|
This API is similar to the
|
||||||
to update the homeserver's more general room directory.
|
[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`)
|
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
|
instead of a typical client's access_token. This API cannot be invoked by
|
||||||
|
|
|
||||||
|
|
@ -87,7 +87,8 @@ paths:
|
||||||
- public
|
- public
|
||||||
- private
|
- private
|
||||||
description: |-
|
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`.
|
Defaults to `private`.
|
||||||
room_alias_name:
|
room_alias_name:
|
||||||
type: string
|
type: string
|
||||||
|
|
|
||||||
|
|
@ -13,13 +13,15 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
openapi: 3.1.0
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Matrix Client-Server Room Directory API
|
title: Matrix Client-Server Published Room Directory API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
paths:
|
paths:
|
||||||
"/directory/list/room/{roomId}":
|
"/directory/list/room/{roomId}":
|
||||||
get:
|
get:
|
||||||
summary: Gets the visibility of a room in the directory
|
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
|
operationId: getRoomVisibilityOnDirectory
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
|
|
@ -63,9 +65,9 @@ paths:
|
||||||
tags:
|
tags:
|
||||||
- Room discovery
|
- Room discovery
|
||||||
put:
|
put:
|
||||||
summary: Sets the visibility of a room in the room directory
|
summary: Sets the visibility of a room in the directory
|
||||||
description: |-
|
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,
|
Servers MAY implement additional access control checks, for instance,
|
||||||
to ensure that a room's visibility can only be changed by the room creator
|
to ensure that a room's visibility can only be changed by the room creator
|
||||||
|
|
@ -99,7 +101,7 @@ paths:
|
||||||
example: {
|
example: {
|
||||||
"visibility": "public"
|
"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
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
|
|
@ -152,8 +154,8 @@ paths:
|
||||||
- in: query
|
- in: query
|
||||||
name: server
|
name: server
|
||||||
description: |-
|
description: |-
|
||||||
The server to fetch the room directory from. Defaults to the
|
The server to fetch the published room directory from. Defaults
|
||||||
local server. Case sensitive.
|
to the local server. Case sensitive.
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
responses:
|
responses:
|
||||||
|
|
@ -180,8 +182,8 @@ paths:
|
||||||
- in: query
|
- in: query
|
||||||
name: server
|
name: server
|
||||||
description: |-
|
description: |-
|
||||||
The server to fetch the room directory from. Defaults to the
|
The server to fetch the published room directory from. Defaults
|
||||||
local server. Case sensitive.
|
to the local server. Case sensitive.
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
requestBody:
|
requestBody:
|
||||||
|
|
|
||||||
|
|
@ -13,12 +13,12 @@
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
openapi: 3.1.0
|
openapi: 3.1.0
|
||||||
info:
|
info:
|
||||||
title: Matrix Federation Room Directory API
|
title: Matrix Federation Published Room Directory API
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
paths:
|
paths:
|
||||||
/publicRooms:
|
/publicRooms:
|
||||||
get:
|
get:
|
||||||
summary: Lists the server's published room directory.
|
summary: Lists the server's published room directory
|
||||||
description: |-
|
description: |-
|
||||||
Lists the server's published room directory.
|
Lists the server's published room directory.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue