proxmox-mirrors/pve-manager
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-manager synced 2025-08-10 16:15:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add/fix option descriptions in pvenode api docs

Browse Source 
Adds some missing descriptions to the api/man page documentation, for
certain options of the `pvenode` command. Some minor language fix-ups
are also included

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
This commit is contained in:
Dylan Whyte 2021-08-31 16:42:24 +02:00 committed by Thomas Lamprecht
parent 013cd17be7
commit e95aae29ac
1 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
PVE/API2/Tasks.pm
View File

@ -82,6 +82,7 @@ __PACKAGE__->register_method({
type => 'boolean', type => 'boolean',
default => 0, default => 0,
optional => 1, optional => 1,
description => 'Only list tasks with a status of ERROR.',
}, },
source => { source => {
type => 'string', type => 'string',
@ -282,7 +283,7 @@ __PACKAGE__->register_method({
method => 'DELETE', method => 'DELETE',
description => 'Stop a task.', description => 'Stop a task.',
permissions => { permissions => {
description => "The user needs 'Sys.Modify' permissions on '/nodes/<node>' if the task does not belong to him.", description => "The user needs 'Sys.Modify' permissions on '/nodes/<node>' if they aren't the owner of the task.",
user => 'all', user => 'all',
}, },
protected => 1, protected => 1,
@ -322,7 +323,7 @@ __PACKAGE__->register_method({
path => '{upid}/log', path => '{upid}/log',
method => 'GET', method => 'GET',
permissions => { permissions => {
description => "The user needs 'Sys.Audit' permissions on '/nodes/<node>' if the task does not belong to him.", description => "The user needs 'Sys.Audit' permissions on '/nodes/<node>' if they aren't the owner of the task.",
user => 'all', user => 'all',
}, },
protected => 1, protected => 1,
@ -332,18 +333,23 @@ __PACKAGE__->register_method({
additionalProperties => 0, additionalProperties => 0,
properties => { properties => {
node => get_standard_option('pve-node'), node => get_standard_option('pve-node'),
upid => { type => 'string' }, upid => {
type => 'string',
description => "The task's unique ID.",
},
start => { start => {
type => 'integer', type => 'integer',
minimum => 0, minimum => 0,
default => 0, default => 0,
optional => 1, optional => 1,
description => "The line number to start printing at.",
}, },
limit => { limit => {
type => 'integer', type => 'integer',
minimum => 0, minimum => 0,
default => 50, default => 50,
optional => 1, optional => 1,
description => "The maximum amount of lines that should be printed.",
}, },
}, },
}, },
@ -396,7 +402,7 @@ __PACKAGE__->register_method({
path => '{upid}/status', path => '{upid}/status',
method => 'GET', method => 'GET',
permissions => { permissions => {
description => "The user needs 'Sys.Audit' permissions on '/nodes/<node>' if the task does not belong to him.", description => "The user needs 'Sys.Audit' permissions on '/nodes/<node>' if they are not the owner of the task.",
user => 'all', user => 'all',
}, },
protected => 1, protected => 1,
@ -406,7 +412,10 @@ __PACKAGE__->register_method({
additionalProperties => 0, additionalProperties => 0,
properties => { properties => {
node => get_standard_option('pve-node'), node => get_standard_option('pve-node'),
upid => { type => 'string' }, upid => {
type => 'string',
description => "The task's unique ID.",
},
}, },
}, },
returns => { returns => {