From: Dylan Whyte <d.whyte@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH pve-manager 1/2] Add/fix option descriptions in pvenode api docs
Date: Tue, 31 Aug 2021 16:42:24 +0200 [thread overview]
Message-ID: <20210831144225.2996999-1-d.whyte@proxmox.com> (raw)
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>
---
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/<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',
},
protected => 1,
@@ -322,7 +323,7 @@ __PACKAGE__->register_method({
path => '{upid}/log',
method => 'GET',
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',
},
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/<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',
},
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
next reply other threads:[~2021-08-31 14:42 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-31 14:42 Dylan Whyte [this message]
2021-08-31 14:42 ` [pve-devel] [PATCH pve-manager 2/2] pvenode task log: don't hardcode 'limit' in CLI Dylan Whyte
2021-08-31 15:08 ` Thomas Lamprecht
2021-08-31 15:03 ` [pve-devel] applied: [PATCH pve-manager 1/2] Add/fix option descriptions in pvenode api docs Thomas Lamprecht
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210831144225.2996999-1-d.whyte@proxmox.com \
--to=d.whyte@proxmox.com \
--cc=pve-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox