From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id C4F436FA39 for ; Tue, 31 Aug 2021 16:42:45 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id B70AF274B3 for ; Tue, 31 Aug 2021 16:42:45 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id C2CBB2749C for ; Tue, 31 Aug 2021 16:42:41 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 4301E4437F for ; Tue, 31 Aug 2021 16:42:41 +0200 (CEST) From: Dylan Whyte To: pve-devel@lists.proxmox.com Date: Tue, 31 Aug 2021 16:42:24 +0200 Message-Id: <20210831144225.2996999-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.601 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [tasks.pm] Subject: [pve-devel] [PATCH pve-manager 1/2] Add/fix option descriptions in pvenode api docs X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 31 Aug 2021 14:42:45 -0000 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 --- PVE/API2/Tasks.pm | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/PVE/API2/Tasks.pm b/PVE/API2/Tasks.pm index 056b698b..9cd1e56b 100644 --- a/PVE/API2/Tasks.pm +++ b/PVE/API2/Tasks.pm @@ -82,6 +82,7 @@ __PACKAGE__->register_method({ type => 'boolean', default => 0, optional => 1, + description => 'Only list tasks with a status of ERROR.', }, source => { type => 'string', @@ -282,7 +283,7 @@ __PACKAGE__->register_method({ method => 'DELETE', description => 'Stop a task.', permissions => { - description => "The user needs 'Sys.Modify' permissions on '/nodes/' if the task does not belong to him.", + description => "The user needs 'Sys.Modify' permissions on '/nodes/' if they aren't the owner of the task.", user => 'all', }, protected => 1, @@ -322,7 +323,7 @@ __PACKAGE__->register_method({ path => '{upid}/log', method => 'GET', permissions => { - description => "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", + description => "The user needs 'Sys.Audit' permissions on '/nodes/' if they aren't the owner of the task.", user => 'all', }, protected => 1, @@ -332,18 +333,23 @@ __PACKAGE__->register_method({ additionalProperties => 0, properties => { node => get_standard_option('pve-node'), - upid => { type => 'string' }, + upid => { + type => 'string', + description => "The task's unique ID.", + }, start => { type => 'integer', minimum => 0, default => 0, optional => 1, + description => "The line number to start printing at.", }, limit => { type => 'integer', minimum => 0, default => 50, optional => 1, + description => "The maximum amount of lines that should be printed.", }, }, }, @@ -396,7 +402,7 @@ __PACKAGE__->register_method({ path => '{upid}/status', method => 'GET', permissions => { - description => "The user needs 'Sys.Audit' permissions on '/nodes/' if the task does not belong to him.", + description => "The user needs 'Sys.Audit' permissions on '/nodes/' if they are not the owner of the task.", user => 'all', }, protected => 1, @@ -406,7 +412,10 @@ __PACKAGE__->register_method({ additionalProperties => 0, properties => { node => get_standard_option('pve-node'), - upid => { type => 'string' }, + upid => { + type => 'string', + description => "The task's unique ID.", + }, }, }, returns => { -- 2.30.2