Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update admin room docs with correct endpoints (#6770)

This commit is contained in:
Andrew Morgan 2020-01-23 11:37:26 +00:00 committed by GitHub
parent 33f7e5ce2a
commit d31f5f4d89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/6770.doc Normal file
View File

@ -0,0 +1 @@
Fix endpoint documentation for the List Rooms admin api.

8
docs/admin_api/rooms.md
View File

@ -46,7 +46,7 @@ The following fields are possible in the JSON response body:
A standard request with no filtering:
```
GET /_synapse/admin/rooms
GET /_synapse/admin/v1/rooms
{}
```
@ -78,7 +78,7 @@ Response:
Filtering by room name:
```
GET /_synapse/admin/rooms?search_term=TWIM
GET /_synapse/admin/v1/rooms?search_term=TWIM
{}
```
@ -103,7 +103,7 @@ Response:
Paginating through a list of rooms:
```
GET /_synapse/admin/rooms?order_by=size
GET /_synapse/admin/v1/rooms?order_by=size
{}
```
@ -139,7 +139,7 @@ To get the next batch of room results, we repeat our request, setting the `from`
parameter to the value of `next_token`.
```
GET /_synapse/admin/rooms?order_by=size&from=100
GET /_synapse/admin/v1/rooms?order_by=size&from=100
{}
```