diff options
| author | Brendan Abolivier <babolivier@matrix.org> | 2020-01-23 12:58:03 +0000 |
|---|---|---|
| committer | Brendan Abolivier <babolivier@matrix.org> | 2020-01-23 12:58:03 +0000 |
| commit | ba64c3b615f8c636edfcd0914dcac14748d2ec5a (patch) | |
| tree | 03ed148f29b9f2b6f69eff9f76172c8add756ae1 | |
| parent | 1.9.0 (diff) | |
| parent | Update admin room docs with correct endpoints (#6770) (diff) | |
| download | synapse-ba64c3b615f8c636edfcd0914dcac14748d2ec5a.tar.xz | |
Merge branch 'release-v1.9.0' of github.com:matrix-org/synapse into release-v1.9.0
| -rw-r--r-- | changelog.d/6770.doc | 1 | ||||
| -rw-r--r-- | docs/admin_api/rooms.md | 8 |
2 files changed, 5 insertions, 4 deletions
diff --git a/changelog.d/6770.doc b/changelog.d/6770.doc new file mode 100644 index 0000000000..a251b82238 --- /dev/null +++ b/changelog.d/6770.doc @@ -0,0 +1 @@ +Fix endpoint documentation for the List Rooms admin api. \ No newline at end of file diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md index 082721ea95..2db457c1b6 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md @@ -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 {} ``` |