Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 65ef21b

Browse files
authored
Clarify that users' media are also preview images (#11862)
1 parent a3865ed commit 65ef21b

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

changelog.d/11862.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Document images returned by the User List Media Admin API can include those generated by URL previews.

docs/admin_api/media_admin_api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
These APIs allow extracting media information from the homeserver.
44

5+
Details about the format of the `media_id` and storage of the media in the file system
6+
are documented under [media repository](../media_repository.md).
7+
58
To use it, you will need to authenticate by providing an `access_token`
69
for a server admin: see [Admin API](../usage/administration/admin_api).
710

docs/admin_api/user_admin_api.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -539,6 +539,11 @@ The following fields are returned in the JSON response body:
539539

540540
### List media uploaded by a user
541541
Gets a list of all local media that a specific `user_id` has created.
542+
These are media that the user has uploaded themselves
543+
([local media](../media_repository.md#local-media)), as well as
544+
[URL preview images](../media_repository.md#url-previews) requested by the user if the
545+
[feature is enabled](../development/url_previews.md).
546+
542547
By default, the response is ordered by descending creation date and ascending media ID.
543548
The newest media is on top. You can change the order with parameters
544549
`order_by` and `dir`.
@@ -635,7 +640,9 @@ The following fields are returned in the JSON response body:
635640
Media objects contain the following fields:
636641
- `created_ts` - integer - Timestamp when the content was uploaded in ms.
637642
- `last_access_ts` - integer - Timestamp when the content was last accessed in ms.
638-
- `media_id` - string - The id used to refer to the media.
643+
- `media_id` - string - The id used to refer to the media. Details about the format
644+
are documented under
645+
[media repository](../media_repository.md).
639646
- `media_length` - integer - Length of the media in bytes.
640647
- `media_type` - string - The MIME-type of the media.
641648
- `quarantined_by` - string - The user ID that initiated the quarantine request

0 commit comments

Comments
 (0)