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 1AC366D2BF for ; Fri, 13 Aug 2021 09:51:29 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 064212A3E2 for ; Fri, 13 Aug 2021 09:50:59 +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 E51CC2A3D4 for ; Fri, 13 Aug 2021 09:50:54 +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 E11AD432E3 for ; Fri, 13 Aug 2021 09:44:11 +0200 (CEST) To: pmg-devel@lists.proxmox.com References: <20210812153010.2327589-1-a.lauterer@proxmox.com> From: Mira Limbeck Message-ID: <4265c847-d303-609c-172c-2e6c32ada8ae@proxmox.com> Date: Fri, 13 Aug 2021 09:44:11 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.12.0 MIME-Version: 1.0 In-Reply-To: <20210812153010.2327589-1-a.lauterer@proxmox.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US X-SPAM-LEVEL: Spam detection results: 0 AWL 0.730 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 NICE_REPLY_A -0.001 Looks like a legit reply (A) 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. [mailtracker.pm] Subject: Re: [pmg-devel] [PATCH pmg-api] API: Mailtracker: add values to rstatus and dstatus description X-BeenThere: pmg-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Mail Gateway development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 13 Aug 2021 07:51:29 -0000 some comments inline On 8/12/21 5:30 PM, Aaron Lauterer wrote: > The possible values were only documented within the source code. Having > them as part of the API description will help people wanting to use the > tracker API endpoint interpreting the results. > > Signed-off-by: Aaron Lauterer > --- > src/PMG/API2/MailTracker.pm | 14 ++++++++++++-- > 1 file changed, 12 insertions(+), 2 deletions(-) > > diff --git a/src/PMG/API2/MailTracker.pm b/src/PMG/API2/MailTracker.pm > index 187decf..952abc8 100644 > --- a/src/PMG/API2/MailTracker.pm > +++ b/src/PMG/API2/MailTracker.pm > @@ -38,6 +38,14 @@ my $statmap = { > Q => 'quarantine', > }; > > +my $print_statmap = sub { > + my $map = ""; > + foreach my $key (sort keys %$statmap) { > + $map .= "$key: $statmap->{$key}\n"; > + } > + return $map; > +}; > + > my $run_pmg_log_tracker = sub { > my ($args, $includelog) = @_; > > @@ -247,13 +255,15 @@ my $email_log_property_desc = { > type => 'integer', > }, > dstatus => { > - description => "Delivery status.", > + description => "Delivery status. Can be one of the following values:\n" . > + $print_statmap->(), Maybe, instead of adding it to the description, change the type from `string` to `enum` with the few possible values. This should result in a nice overview of the possible return values in the API viewer. > type => 'string', > minLength => 1, > maxLength => 1, > }, > rstatus => { > - description => "Delivery status of relayed mail.", > + description => "Delivery status of relayed mail. Can be one of the " . > + "following values:\n" . $print_statmap->(), Same here, as only `2`, `4` and `5` are valid `rstatus` values. > type => 'string', > minLength => 1, > maxLength => 1,