summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2021-03-09 15:15:52 +0000
committerGitHub <noreply@github.com>2021-03-09 15:15:52 +0000
commite9df3f496b80e77125837951c0a0b56c3f5bf9a2 (patch)
treedb68fa7df9e275d92f1853a8112d4b1f474b1894
parentJWT OIDC secrets for Sign in with Apple (#9549) (diff)
downloadsynapse-e9df3f496b80e77125837951c0a0b56c3f5bf9a2.tar.xz
Link to the List user's media admin API from media Admin API docs (#9571)
Earlier [I was convinced](https://github.com/matrix-org/synapse/issues/9565) that we didn't have an Admin API for listing media uploaded by a user. Foolishly I was looking under the Media Admin API documentation, instead of the User Admin API documentation.

I thought it'd be helpful to link to the latter so others don't hit the same dead end :)
-rw-r--r--changelog.d/9571.doc1
-rw-r--r--docs/admin_api/media_admin_api.md16
2 files changed, 15 insertions, 2 deletions
diff --git a/changelog.d/9571.doc b/changelog.d/9571.doc
new file mode 100644
index 0000000000..1bba72e7d0
--- /dev/null
+++ b/changelog.d/9571.doc
@@ -0,0 +1 @@
+Link to the "List user's media" admin API from the media admin API docs.
diff --git a/docs/admin_api/media_admin_api.md b/docs/admin_api/media_admin_api.md
index 90faeaaef0..9dbec68c19 100644
--- a/docs/admin_api/media_admin_api.md
+++ b/docs/admin_api/media_admin_api.md
@@ -1,5 +1,7 @@
 # Contents
-- [List all media in a room](#list-all-media-in-a-room)
+- [Querying media](#querying-media)
+  * [List all media in a room](#list-all-media-in-a-room)
+  * [List all media uploaded by a user](#list-all-media-uploaded-by-a-user)
 - [Quarantine media](#quarantine-media)
   * [Quarantining media by ID](#quarantining-media-by-id)
   * [Quarantining media in a room](#quarantining-media-in-a-room)
@@ -10,7 +12,11 @@
   * [Delete local media by date or size](#delete-local-media-by-date-or-size)
 - [Purge Remote Media API](#purge-remote-media-api)
 
-# List all media in a room
+# Querying media
+
+These APIs allow extracting media information from the homeserver.
+
+## 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.
@@ -36,6 +42,12 @@ The API returns a JSON body like the following:
 }
 ```
 
+## List all media uploaded by a user
+
+Listing all media that has been uploaded by a local user can be achieved through
+the use of the [List media of a user](user_admin_api.rst#list-media-of-a-user)
+Admin API.
+
 # Quarantine media
 
 Quarantining media means that it is marked as inaccessible by users. It applies