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) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 2572B96BEA for ; Thu, 26 Jan 2023 15:30:50 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 98B61245D5 for ; Thu, 26 Jan 2023 15:30:49 +0100 (CET) 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 for ; Thu, 26 Jan 2023 15:30:47 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 27ECF465B5 for ; Thu, 26 Jan 2023 15:30:47 +0100 (CET) From: Leo Nunner To: pve-devel@lists.proxmox.com Date: Thu, 26 Jan 2023 15:30:17 +0100 Message-Id: <20230126143020.150338-3-l.nunner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20230126143020.150338-1-l.nunner@proxmox.com> References: <20230126143020.150338-1-l.nunner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 2.476 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 RCVD_IN_DNSWL_HI -5 Sender listed at https://www.dnswl.org/, high trust 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. [groups.pm, ipset.pm] Subject: [pve-devel] [PATCH firewall 2/4] docs: clarify usage of 'rename' parameters 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: Thu, 26 Jan 2023 14:30:50 -0000 Signed-off-by: Leo Nunner --- src/PVE/API2/Firewall/Aliases.pm | 2 +- src/PVE/API2/Firewall/Groups.pm | 2 +- src/PVE/API2/Firewall/IPSet.pm | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/PVE/API2/Firewall/Aliases.pm b/src/PVE/API2/Firewall/Aliases.pm index 88f20a0..c1af408 100644 --- a/src/PVE/API2/Firewall/Aliases.pm +++ b/src/PVE/API2/Firewall/Aliases.pm @@ -16,7 +16,7 @@ my $api_properties = { }, name => get_standard_option('pve-fw-alias'), rename => get_standard_option('pve-fw-alias', { - description => "Rename an existing alias.", + description => "Rename an existing alias to the value provided.", optional => 1, }), comment => { diff --git a/src/PVE/API2/Firewall/Groups.pm b/src/PVE/API2/Firewall/Groups.pm index a0695ce..cf9dc06 100644 --- a/src/PVE/API2/Firewall/Groups.pm +++ b/src/PVE/API2/Firewall/Groups.pm @@ -90,7 +90,7 @@ __PACKAGE__->register_method({ optional => 1, }, rename => get_standard_option('pve-security-group-name', { - description => "Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.", + description => "Specify a group to be renamed/updated. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.", optional => 1, }), digest => get_standard_option('pve-config-digest'), diff --git a/src/PVE/API2/Firewall/IPSet.pm b/src/PVE/API2/Firewall/IPSet.pm index 0e6b1d6..fee9046 100644 --- a/src/PVE/API2/Firewall/IPSet.pm +++ b/src/PVE/API2/Firewall/IPSet.pm @@ -624,7 +624,7 @@ sub register_create { $properties->{digest} = get_standard_option('pve-config-digest'); $properties->{rename} = get_standard_option('ipset-name', { - description => "Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.", + description => "Specify an IPset to be renamed/updated. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.", optional => 1 }); $class->register_method({ -- 2.30.2