Skip to content

Commit

Permalink
Clarify documentation of the scan endpoint (#44)
Browse files Browse the repository at this point in the history
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>

I think there was a copy-paste error here, otherwise this API is missing
a way to scan the actual media which I find hard to believe.

Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
  • Loading branch information
HarHarLinks authored Jan 24, 2023
1 parent 4f59abc commit 23c636a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ unsuccessful, an error is sent with the reason `MCS_MEDIA_NOT_CLEAN`.

### `GET /_matrix/media_proxy/unstable/scan/{serverName}/{mediaId}`

Downloads a thumbnail of the media at `mxc://{serverName}/{mediaId}`, scans it and
Downloads the media at `mxc://{serverName}/{mediaId}`, scans it and
responds with the result of the scan.

Response format:
Expand Down Expand Up @@ -178,4 +178,4 @@ Example (generated using the body and public key from the previous examples):
"ephemeral": "fk2xOTmttnFDTAORxVQTtIlbsu7O01Oe52+umaOjIiE"
}
}
```
```

0 comments on commit 23c636a

Please sign in to comment.