OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Update admin user API return types in docs. (#16654)

pull/16659/head
Michael Weimann 2023-11-17 14:38:25 +01:00 committed by GitHub
parent 700c8a0de5
commit 518e4de758
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/16654.doc Normal file
View File

@ -0,0 +1 @@
Provide an example for a common encrypted media response from the admin user media API and mention possible null values.

19
docs/admin_api/user_admin_api.md
View File

@ -618,6 +618,16 @@ A response body like the following is returned:
"quarantined_by": null, "quarantined_by": null,
"safe_from_quarantine": false, "safe_from_quarantine": false,
"upload_name": "test2.png" "upload_name": "test2.png"
},
{
"created_ts": 300400,
"last_access_ts": 300700,
"media_id": "BzYNLRUgGHphBkdKGbzXwbjX",
"media_length": 1337,
"media_type": "application/octet-stream",
"quarantined_by": null,
"safe_from_quarantine": false,
"upload_name": null
} }
], ],
"next_token": 3, "next_token": 3,
@ -679,16 +689,17 @@ The following fields are returned in the JSON response body:
- `media` - An array of objects, each containing information about a media. - `media` - An array of objects, each containing information about a media.
Media objects contain the following fields: Media objects contain the following fields:
- `created_ts` - integer - Timestamp when the content was uploaded in ms. - `created_ts` - integer - Timestamp when the content was uploaded in ms.
- `last_access_ts` - integer - Timestamp when the content was last accessed in ms. - `last_access_ts` - integer or null - Timestamp when the content was last accessed in ms.
Null if there was no access, yet.
- `media_id` - string - The id used to refer to the media. Details about the format - `media_id` - string - The id used to refer to the media. Details about the format
are documented under are documented under
[media repository](../media_repository.md). [media repository](../media_repository.md).
- `media_length` - integer - Length of the media in bytes. - `media_length` - integer - Length of the media in bytes.
- `media_type` - string - The MIME-type of the media. - `media_type` - string - The MIME-type of the media.
- `quarantined_by` - string - The user ID that initiated the quarantine request - `quarantined_by` - string or null - The user ID that initiated the quarantine request
for this media. for this media. Null if not quarantined.
- `safe_from_quarantine` - bool - Status if this media is safe from quarantining. - `safe_from_quarantine` - bool - Status if this media is safe from quarantining.
- `upload_name` - string - The name the media was uploaded with. - `upload_name` - string or null - The name the media was uploaded with. Null if not provided during upload.
- `next_token`: integer - Indication for pagination. See above. - `next_token`: integer - Indication for pagination. See above.
- `total` - integer - Total number of media. - `total` - integer - Total number of media.