Fix user reports API docs (#29506)
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
Этот коммит содержится в:
коммит произвёл
GitHub
родитель
d316df6d28
Коммит
89e250e5b7
@@ -3698,14 +3698,39 @@ components:
|
||||
description: The time in milliseconds a user was created
|
||||
type: integer
|
||||
format: int64
|
||||
update_at:
|
||||
description: The time in milliseconds a user was last updated
|
||||
type: integer
|
||||
format: int64
|
||||
delete_at:
|
||||
description: The time in milliseconds a user was deleted
|
||||
type: integer
|
||||
format: int64
|
||||
username:
|
||||
type: string
|
||||
auth_data:
|
||||
type: string
|
||||
auth_service:
|
||||
type: string
|
||||
email:
|
||||
type: string
|
||||
display_name:
|
||||
nickname:
|
||||
type: string
|
||||
description: Calculated display name based on user
|
||||
last_login_at:
|
||||
first_name:
|
||||
type: string
|
||||
last_name:
|
||||
type: string
|
||||
position:
|
||||
type: string
|
||||
roles:
|
||||
type: string
|
||||
locale:
|
||||
type: string
|
||||
timezone:
|
||||
$ref: "#/components/schemas/Timezone"
|
||||
disable_welcome_email:
|
||||
type: boolean
|
||||
last_login:
|
||||
description: Last time the user was logged in
|
||||
type: integer
|
||||
format: int64
|
||||
|
||||
@@ -6,8 +6,6 @@
|
||||
description: >
|
||||
Get a list of paged users for admin reporting purposes, based on provided parameters.
|
||||
|
||||
Must be a system admin to invoke this API.
|
||||
|
||||
##### Permissions
|
||||
|
||||
Requires `sysconsole_read_user_management_users`.
|
||||
@@ -22,10 +20,10 @@
|
||||
default: 'Username'
|
||||
- name: direction
|
||||
in: query
|
||||
description: The direction in which to accept paging values from. Will return values ahead of the cursor if "up", and below the cursor if "down". Default is "down".
|
||||
description: The direction to accept paging values from. Will return values ahead of the cursor if "prev", and below the cursor if "next". Default is "next".
|
||||
schema:
|
||||
type: string
|
||||
default: 'down'
|
||||
default: 'next'
|
||||
- name: sort_direction
|
||||
in: query
|
||||
description: The sorting direction. Must be one of ("asc", "desc"). Will default to 'asc' if not specified or the input is invalid.
|
||||
@@ -110,9 +108,6 @@
|
||||
summary: Gets the full count of users that match the filter.
|
||||
description: >
|
||||
Get the full count of users admin reporting purposes, based on provided parameters.
|
||||
|
||||
|
||||
Must be a system admin to invoke this API.
|
||||
|
||||
##### Permissions
|
||||
|
||||
@@ -163,9 +158,6 @@
|
||||
summary: Starts a job to export the users to a report file.
|
||||
description: >
|
||||
Starts a job to export the users to a report file.
|
||||
|
||||
|
||||
Must be a system admin to invoke this API.
|
||||
|
||||
##### Permissions
|
||||
|
||||
|
||||
Ссылка в новой задаче
Block a user