Clarify documentation of the scan endpoint (#44)

HarHarLinks · web-flow · commit 23c636a01170 · 2023-01-24T14:23:46.000Z
Signed-off-by: Kim Brose &lt;2803622+HarHarLinks@users.noreply.github.com&gt;

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 &lt;2803622+HarHarLinks@users.noreply.github.com&gt;
diff --git a/docs/api.md b/docs/api.md
@@ -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:
@@ -178,4 +178,4 @@ Example (generated using the body and public key from the previous examples):
         "ephemeral": "fk2xOTmttnFDTAORxVQTtIlbsu7O01Oe52+umaOjIiE"
     }
 }
-```
+```

Original file line number	Diff line number	Diff line change
@@ -57,7 +57,7 @@ unsuccessful, an error is sent with the reason `MCS_MEDIA_NOT_CLEAN`.
`57`	`57`
`58`	`58`	### `GET /_matrix/media_proxy/unstable/scan/{serverName}/{mediaId}`
`59`	`59`
`60`		-Downloads a thumbnail of the media at `mxc://{serverName}/{mediaId}`, scans it and
	`60`	+Downloads the media at `mxc://{serverName}/{mediaId}`, scans it and
`61`	`61`	`responds with the result of the scan.`
`62`	`62`
`63`	`63`	`Response format:`
`@@ -178,4 +178,4 @@ Example (generated using the body and public key from the previous examples):`
`178`	`178`	`"ephemeral": "fk2xOTmttnFDTAORxVQTtIlbsu7O01Oe52+umaOjIiE"`
`179`	`179`	`}`
`180`	`180`	`}`
`181`		-```
	`181`	+```