Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
518e4de7
Unverified
Commit
518e4de7
authored
1 year ago
by
Michael Weimann
Committed by
GitHub
1 year ago
Browse files
Options
Downloads
Patches
Plain Diff
Update admin user API return types in docs. (#16654)
parent
700c8a0d
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
changelog.d/16654.doc
+1
-0
1 addition, 0 deletions
changelog.d/16654.doc
docs/admin_api/user_admin_api.md
+15
-4
15 additions, 4 deletions
docs/admin_api/user_admin_api.md
with
16 additions
and
4 deletions
changelog.d/16654.doc
0 → 100644
+
1
−
0
View file @
518e4de7
Provide an example for a common encrypted media response from the admin user media API and mention possible null values.
This diff is collapsed.
Click to expand it.
docs/admin_api/user_admin_api.md
+
15
−
4
View file @
518e4de7
...
...
@@ -618,6 +618,16 @@ A response body like the following is returned:
"quarantined_by"
:
null
,
"safe_from_quarantine"
:
false
,
"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
,
...
...
@@ -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 objects contain the following fields:
-
`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
are documented under
[
media repository
](
../media_repository.md
)
.
-
`media_length`
- integer - Length of the media in bytes.
-
`media_type`
- string - The MIME-type of the media.
-
`quarantined_by`
- string - The user ID that initiated the quarantine request
for this media.
-
`quarantined_by`
- string
or null
- The user ID that initiated the quarantine request
for this media.
Null if not quarantined.
-
`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.
-
`total`
- integer - Total number of media.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment