From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id 21D6F1FF187 for ; Mon, 22 Sep 2025 18:47:30 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 5696320A08; Mon, 22 Sep 2025 18:47:57 +0200 (CEST) Message-ID: <5a4c16f9-c5e8-4c21-9d60-d87c8b37ad39@proxmox.com> Date: Mon, 22 Sep 2025 18:47:23 +0200 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Beta To: Proxmox VE development discussion , n.frey@proxmox.com References: <20250919093915.21641-1-n.frey@proxmox.com> <20250919093915.21641-3-n.frey@proxmox.com> Content-Language: en-US From: Thomas Lamprecht In-Reply-To: <20250919093915.21641-3-n.frey@proxmox.com> X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1758559631416 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.028 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: Re: [pve-devel] [PATCH pve-manager 2/5] api: add ACME plugin return schema 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: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" Am 19.09.25 um 11:40 schrieb n.frey@proxmox.com: > From: Nicolas Frey > FYI: these methods are operating on modules that base off a so called SectionConfig. This is quite widely used in our stack, not only in PVE but also in rust based projects like PBS. I'd recommend skimming the SectionConfig.pm in the pve-commong git repo to get a basic overview. And as the underlying config types (meaning dns and standalone) already define a schema for their respective config types, and while we did not really reuse that for return schema until now IIRC, it might actually work quite well to reuse the createSchema method (or a slight derivation from that). That said, doing that naturally adds a bit of scope to the task you're doing here, might be still a nice learning experience in any case though. The rest of the review commits are written such that they ignore the potential for reusing the SectionConfig for the schema. > Signed-off-by: Nicolas Frey > --- > PVE/API2/ACMEPlugin.pm | 49 ++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 49 insertions(+) > > diff --git a/PVE/API2/ACMEPlugin.pm b/PVE/API2/ACMEPlugin.pm > index 510101aa..b67cb1ff 100644 > --- a/PVE/API2/ACMEPlugin.pm > +++ b/PVE/API2/ACMEPlugin.pm > @@ -76,6 +76,29 @@ __PACKAGE__->register_method({ > type => "object", > properties => { > plugin => get_standard_option('pve-acme-pluginid'), > + 'validation-delay' => { > + type => 'integer', > + description => 'Waiting period after a DNS record is created.', Stating the unit is always great for such things, as else the user has to guess if this is milliseconds, seconds, minutes, ... The wording is also slightly ambiguous IMO, maybe go with something like: The waiting period in seconds before validation starts after a DNS challenge record has been created. > + default => 30, > + optional => 1 > + }, > + data => { > + type => 'string', > + description => 'Additional data like keys, server, url etc.', > + optional => 1 > + }, > + api => { > + type => 'string', > + description => 'One of the DNS APIs listed in /json/cluster/challenge-schema.' Referring to another API endpoint can be OK, but I'd not include the formatter, as we have multiple ones (e.g. json, extjs, html). And this should be marked as optional, as while it's always present for the plugins of type "dns", it isn't for the ones of type "standalone" (HTTP challenge). > + }, > + digest => { > + type => 'string', > + description => 'Digest to detect modification.' > + }, > + type => { > + type => 'string', > + description => '' Should have a description and could be a enumeration of the possible variants, i.e.: enum => ['dns', 'standalone'] > + }, > }, > }, > links => [{ rel => 'child', href => "{plugin}" }], > @@ -113,6 +136,32 @@ __PACKAGE__->register_method({ > }, > returns => { > type => 'object', > + properties => { > + plugin => get_standard_option('pve-acme-pluginid'), > + 'validation-delay' => { > + type => 'integer', > + description => 'Waiting period after a DNS record is created.', > + default => 30, > + optional => 1 > + }, > + data => { > + type => 'string', > + description => 'Additional data like keys, server, url etc.', > + optional => 1 > + }, > + api => { > + type => 'string', > + description => 'One of the DNS APIs listed in /json/cluster/challenge-schema.' > + }, > + digest => { > + type => 'string', > + description => '' > + }, > + type => { > + type => 'string', > + description => '' > + }, shares comments with above, and FWIW, even if we do not want to reuse the section config schema, we still could use a hash variable to reuse the same schema between both methods, once nested in an array and once as directed return schema. > + }, > }, > code => sub { > my ($param) = @_; _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel