diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-06-05 17:31:05 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-05 17:31:05 +0100 |
| commit | 1bc00fd76d1741477ff8ae4f2cc68102d483014c (patch) | |
| tree | ab3eacc6d4bed99a6ef4b3fe20db9e7e059e0a41 /docs/admin_api/media_admin_api.md | |
| parent | Update to the stable SSO prefix for UI Auth. (#7630) (diff) | |
| download | synapse-1bc00fd76d1741477ff8ae4f2cc68102d483014c.tar.xz | |
Clarifications to the admin api documentation (#7647)
* Clarify how to authenticate * path params are not the same thing as query params * Fix documentation for `/_synapse/admin/v2/users/<user_id>`
Diffstat (limited to 'docs/admin_api/media_admin_api.md')
| -rw-r--r-- | docs/admin_api/media_admin_api.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md index 46ba7a1a71..26948770d8 100644 --- a/docs/admin_api/media_admin_api.md +++ b/docs/admin_api/media_admin_api.md @@ -6,9 +6,10 @@ The API is: ``` GET /_synapse/admin/v1/room/<room_id>/media ``` -including an `access_token` of a server admin. +To use it, you will need to authenticate by providing an `access_token` for a +server admin: see [README.rst](README.rst). -It returns a JSON body like the following: +The API returns a JSON body like the following: ``` { "local": [ @@ -99,4 +100,3 @@ Response: "num_quarantined": 10 # The number of media items successfully quarantined } ``` - |