Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation of the scan endpoint #44

Merged
merged 1 commit into from
Jan 24, 2023
Merged

Clarify documentation of the scan endpoint #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api.md
View file
Open in desktop
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"
}
}
```
```