Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2025-05-02 19:24:51 -04:00
Code Issues Projects Releases Packages Wiki Activity

Clarifications to the admin api documentation (#7647)

Browse source 
* Clarify how to authenticate
* path params are not the same thing as query params
* Fix documentation for `/_synapse/admin/v2/users/<user_id>`
This commit is contained in:
Richard van der Hoff 2020-06-05 17:31:05 +01:00 • committed by GitHub
parent a0d2d81cf9
commit 1bc00fd76d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 126 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/admin_api/media_admin_api.md
View file

@ -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
}
```