From: Stoiko Ivanov <s.ivanov@proxmox.com>
To: pmg-devel@lists.proxmox.com
Subject: [pmg-devel] [PATCH pmg-api v2 2/5] api: statistics: refactor return for detail calls
Date: Thu, 21 Jan 2021 16:51:03 +0100 [thread overview]
Message-ID: <20210121155107.1971-3-s.ivanov@proxmox.com> (raw)
In-Reply-To: <20210121155107.1971-1-s.ivanov@proxmox.com>
all api methods returning information for a particular sender,
receiver or contact have similar returns.
This commit pulls the common ones out into a sub like the common method
parameters in $default_properties.
Signed-off-by: Stoiko Ivanov <s.ivanov@proxmox.com>
---
v1->v2:
* keep the common properties in a sub instead of a hash (for consistency
with $default_properties)
src/PMG/API2/Statistics.pm | 109 ++++++++++++++-----------------------
1 file changed, 40 insertions(+), 69 deletions(-)
diff --git a/src/PMG/API2/Statistics.pm b/src/PMG/API2/Statistics.pm
index adc7650..064865d 100644
--- a/src/PMG/API2/Statistics.pm
+++ b/src/PMG/API2/Statistics.pm
@@ -257,6 +257,40 @@ __PACKAGE__->register_method ({
return $res;
}});
+my $detail_return_properties = sub {
+ my ($prop) = @_;
+
+ $prop //= {};
+
+ $prop->{time} = {
+ description => "Receive time stamp",
+ type => 'integer',
+ };
+
+ $prop->{bytes} = {
+ description => "Mail traffic (Bytes).",
+ type => 'number',
+ };
+
+ $prop->{blocked} = {
+ description => "Mail was blocked.",
+ type => 'boolean',
+ };
+
+ $prop->{spamlevel} = {
+ description => "Spam score.",
+ type => 'number',
+ };
+
+ $prop->{virusinfo} = {
+ description => "Virus name.",
+ type => 'string',
+ optional => 1,
+ };
+
+ return $prop;
+};
+
__PACKAGE__->register_method ({
name => 'contactdetails',
path => 'contact/{contact}',
@@ -282,33 +316,12 @@ __PACKAGE__->register_method ({
type => 'array',
items => {
type => "object",
- properties => {
- time => {
- description => "Receive time stamp",
- type => 'integer',
- },
+ properties => $detail_return_properties->({
sender => {
description => "Sender email.",
type => 'string',
},
- bytes => {
- description => "Mail traffic (Bytes).",
- type => 'number',
- },
- blocked => {
- description => "Mail was blocked.",
- type => 'boolean',
- },
- spamlevel => {
- description => "Spam score.",
- type => 'number',
- },
- virusinfo => {
- description => "Virus name.",
- type => 'string',
- optional => 1,
- },
- },
+ }),
},
},
code => sub {
@@ -421,33 +434,12 @@ __PACKAGE__->register_method ({
type => 'array',
items => {
type => "object",
- properties => {
- time => {
- description => "Receive time stamp",
- type => 'integer',
- },
+ properties => $detail_return_properties->({
receiver => {
description => "Receiver email.",
type => 'string',
},
- bytes => {
- description => "Mail traffic (Bytes).",
- type => 'number',
- },
- blocked => {
- description => "Mail was blocked.",
- type => 'boolean',
- },
- spamlevel => {
- description => "Spam score.",
- type => 'number',
- },
- virusinfo => {
- description => "Virus name.",
- type => 'string',
- optional => 1,
- },
- },
+ }),
},
},
code => sub {
@@ -568,33 +560,12 @@ __PACKAGE__->register_method ({
type => 'array',
items => {
type => "object",
- properties => {
- time => {
- description => "Receive time stamp",
- type => 'integer',
- },
+ properties => $detail_return_properties->({
sender => {
description => "Sender email.",
type => 'string',
},
- bytes => {
- description => "Mail traffic (Bytes).",
- type => 'number',
- },
- blocked => {
- description => "Mail was blocked.",
- type => 'boolean',
- },
- spamlevel => {
- description => "Spam score.",
- type => 'number',
- },
- virusinfo => {
- description => "Virus name.",
- type => 'string',
- optional => 1,
- },
- },
+ }),
},
},
code => sub {
--
2.20.1
next prev parent reply other threads:[~2021-01-21 15:51 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-21 15:51 [pmg-devel] [PATCH pmg-api v2 0/5] allow / in local part of pmg-email-address Stoiko Ivanov
2021-01-21 15:51 ` [pmg-devel] [PATCH pmg-api v2 1/5] api: statistics: remove unneeded RESTEnvironment Stoiko Ivanov
2021-01-27 8:34 ` [pmg-devel] applied: " Thomas Lamprecht
2021-01-21 15:51 ` Stoiko Ivanov [this message]
2021-01-27 8:34 ` [pmg-devel] applied: [PATCH pmg-api v2 2/5] api: statistics: refactor return for detail calls Thomas Lamprecht
2021-01-21 15:51 ` [pmg-devel] [PATCH pmg-api v2 3/5] api: statistics: refactor " Stoiko Ivanov
2021-01-27 8:34 ` [pmg-devel] applied: " Thomas Lamprecht
2021-01-21 15:51 ` [pmg-devel] [PATCH pmg-api v2] api: statistics: make email a parameter Stoiko Ivanov
2021-01-27 8:49 ` Thomas Lamprecht
2021-01-21 15:51 ` [pmg-devel] [PATCH pmg-api v2 5/5] utils: allow '/' inside email address localpart Stoiko Ivanov
2021-01-21 15:51 ` [pmg-devel] [PATCH pmg-gui v2 1/1] statistics: use new api structure for detailed stats Stoiko Ivanov
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=20210121155107.1971-3-s.ivanov@proxmox.com \
--to=s.ivanov@proxmox.com \
--cc=pmg-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