forked from matrix-org/matrix-spec-proposals
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document the /publicRooms endpoint for federation
This intentionally doesn't document the third party network aspect of the endpoint. This is scheduled for a later area for dealing with third party network/IDs and is reported as matrix-org#1476 The client-server response has been broken out to a shared file: both the client-server and server-server /publicRoom endpoints return the same thing, with slightly different inputs. The inputs (and behaviour) are based upon the docstring here: https://github.com/matrix-org/synapse/blob/43ecfe0b1028fea5e4dda197f5631aed67182ee6/synapse/federation/transport/server.py#L583-L612
- Loading branch information
Showing
4 changed files
with
168 additions
and
92 deletions.
There are no files selected for viewing
105 changes: 105 additions & 0 deletions
105
api/client-server/definitions/public_rooms_response.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # Copyright 2018 New Vector Ltd | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| type: object | ||
| description: A list of the rooms on the server. | ||
| required: ["chunk"] | ||
| properties: | ||
| chunk: | ||
| title: "PublicRoomsChunks" | ||
| type: array | ||
| description: |- | ||
| A paginated chunk of public rooms. | ||
| items: | ||
| type: object | ||
| title: "PublicRoomsChunk" | ||
| required: | ||
| - room_id | ||
| - num_joined_members | ||
| - world_readable | ||
| - guest_can_join | ||
| properties: | ||
| aliases: | ||
| type: array | ||
| description: |- | ||
| Aliases of the room. May be empty. | ||
| items: | ||
| type: string | ||
| canonical_alias: | ||
| type: string | ||
| description: |- | ||
| The canonical alias of the room, if any. | ||
| name: | ||
| type: string | ||
| description: |- | ||
| The name of the room, if any. | ||
| num_joined_members: | ||
| type: number | ||
| description: |- | ||
| The number of members joined to the room. | ||
| room_id: | ||
| type: string | ||
| description: |- | ||
| The ID of the room. | ||
| topic: | ||
| type: string | ||
| description: |- | ||
| The topic of the room, if any. | ||
| world_readable: | ||
| type: boolean | ||
| description: |- | ||
| Whether the room may be viewed by guest users without joining. | ||
| guest_can_join: | ||
| type: boolean | ||
| description: |- | ||
| Whether guest users may join the room and participate in it. | ||
| If they can, they will be subject to ordinary power level | ||
| rules like any other user. | ||
| avatar_url: | ||
| type: string | ||
| description: The URL for the room's avatar, if one is set. | ||
| next_batch: | ||
| type: string | ||
| description: |- | ||
| A pagination token for the response. The absence of this token | ||
| means there are no more results to fetch and the client should | ||
| stop paginating. | ||
| prev_batch: | ||
| type: string | ||
| description: |- | ||
| A pagination token that allows fetching previous results. The | ||
| absence of this token means there are no results before this | ||
| batch, i.e. this is the first batch. | ||
| total_room_count_estimate: | ||
| type: number | ||
| description: |- | ||
| An estimate on the total number of public rooms, if the | ||
| server has an estimate. | ||
| example: { | ||
| "chunk": [ | ||
| { | ||
| "aliases": ["#murrays:cheese.bar"], | ||
| "avatar_url": "mxc://bleeker.street/CHEDDARandBRIE", | ||
| "guest_can_join": false, | ||
| "name": "CHEESE", | ||
| "num_joined_members": 37, | ||
| "room_id": "!ol19s:bleecker.street", | ||
| "topic": "Tasty tasty cheese", | ||
| "world_readable": true | ||
| } | ||
| ], | ||
| "next_batch": "p190q", | ||
| "prev_batch": "p1902", | ||
| "total_room_count_estimate": 115 | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Copyright 2018 New Vector Ltd | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| swagger: '2.0' | ||
| info: | ||
| title: "Matrix Federation Public Rooms API" | ||
| version: "1.0.0" | ||
| host: localhost:8448 | ||
| schemes: | ||
| - https | ||
| basePath: /_matrix/federation/v1 | ||
| produces: | ||
| - application/json | ||
| paths: | ||
| "/publicRooms": | ||
| get: | ||
| summary: Get all the public rooms for a homeserver | ||
| description: |- | ||
| Gets all the public rooms for the homeserver. This should not return | ||
| rooms that are listed on another homeserver's directory, just those | ||
| listed on the receiving homeserver's directory. | ||
| operationId: getPublicRooms | ||
| parameters: | ||
| - in: query | ||
| name: limit | ||
| type: integer | ||
| description: |- | ||
| The maximum number of rooms to return. Defaults to 0 (no limit). | ||
| x-example: 10 | ||
| - in: query | ||
| name: since | ||
| type: string | ||
| description: |- | ||
| A pagination token from a previous call to this endpoint to fetch more | ||
| rooms. | ||
| x-example: "GetMoreRoomsTokenHere" | ||
| responses: | ||
| 200: | ||
| description: The public room list for the homeserver. | ||
| schema: | ||
| $ref: "../client-server/definitions/public_rooms_response.yaml" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters