summary refs log tree commit diff
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2020-11-24 15:04:51 +0100
committerGitHub <noreply@github.com>2020-11-24 09:04:51 -0500
commitb08dc7effed4a880384e386cdca50c5d15870904 (patch)
tree5ba3f0b08cc17e46e691fdcfe1ce4da8a5bea83a
parentAdd a script to sign arbitrary json objects. (#8772) (diff)
downloadsynapse-b08dc7effed4a880384e386cdca50c5d15870904.tar.xz
Clarify documentation of the admin list media API (#8795)
Clarify that the list media API only shows media from unencrypted events.
-rw-r--r--changelog.d/8795.doc1
-rw-r--r--docs/admin_api/media_admin_api.md1
2 files changed, 2 insertions, 0 deletions
diff --git a/changelog.d/8795.doc b/changelog.d/8795.doc
new file mode 100644
index 0000000000..f97a74efb5
--- /dev/null
+++ b/changelog.d/8795.doc
@@ -0,0 +1 @@
+Improve the documentation for the admin API to list all media in a room with respect to encrypted events.
diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md
index 3994e1f1a9..71137c6dfc 100644
--- a/docs/admin_api/media_admin_api.md
+++ b/docs/admin_api/media_admin_api.md
@@ -1,6 +1,7 @@
 # List all media in a room
 
 This API gets a list of known media in a room.
+However, it only shows media from unencrypted events or rooms.
 
 The API is:
 ```