From: Lukas Wagner <l.wagner@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v5 pve-manager 07/30] api: prepare api handler module for notification config
Date: Wed, 26 Jul 2023 11:49:39 +0200 [thread overview]
Message-ID: <20230726095002.325276-8-l.wagner@proxmox.com> (raw)
In-Reply-To: <20230726095002.325276-1-l.wagner@proxmox.com>
This commit adds a new Perl module, PVE::API2::Cluster::Notification.
The module will contain all API handlers for the new notification
subsystem.
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
PVE/API2/Cluster.pm | 7 +++
PVE/API2/Cluster/Makefile | 1 +
PVE/API2/Cluster/Notifications.pm | 71 +++++++++++++++++++++++++++++++
3 files changed, 79 insertions(+)
create mode 100644 PVE/API2/Cluster/Notifications.pm
diff --git a/PVE/API2/Cluster.pm b/PVE/API2/Cluster.pm
index 3daf6ae5..2e4cd9cc 100644
--- a/PVE/API2/Cluster.pm
+++ b/PVE/API2/Cluster.pm
@@ -29,6 +29,7 @@ use PVE::API2::Cluster::Ceph;
use PVE::API2::Cluster::Mapping;
use PVE::API2::Cluster::Jobs;
use PVE::API2::Cluster::MetricServer;
+use PVE::API2::Cluster::Notifications;
use PVE::API2::ClusterConfig;
use PVE::API2::Firewall::Cluster;
use PVE::API2::HAConfig;
@@ -52,6 +53,11 @@ __PACKAGE__->register_method ({
path => 'metrics',
});
+__PACKAGE__->register_method ({
+ subclass => "PVE::API2::Cluster::Notifications",
+ path => 'notifications',
+});
+
__PACKAGE__->register_method ({
subclass => "PVE::API2::ClusterConfig",
path => 'config',
@@ -149,6 +155,7 @@ __PACKAGE__->register_method ({
{ name => 'log' },
{ name => 'mapping' },
{ name => 'metrics' },
+ { name => 'notifications' },
{ name => 'nextid' },
{ name => 'options' },
{ name => 'replication' },
diff --git a/PVE/API2/Cluster/Makefile b/PVE/API2/Cluster/Makefile
index 0c52a241..b109e5cb 100644
--- a/PVE/API2/Cluster/Makefile
+++ b/PVE/API2/Cluster/Makefile
@@ -8,6 +8,7 @@ PERLSOURCE= \
BackupInfo.pm \
MetricServer.pm \
Mapping.pm \
+ Notifications.pm \
Jobs.pm \
Ceph.pm
diff --git a/PVE/API2/Cluster/Notifications.pm b/PVE/API2/Cluster/Notifications.pm
new file mode 100644
index 00000000..1efebbc1
--- /dev/null
+++ b/PVE/API2/Cluster/Notifications.pm
@@ -0,0 +1,71 @@
+package PVE::API2::Cluster::Notifications;
+
+use warnings;
+use strict;
+
+use Storable qw(dclone);
+use JSON;
+
+use PVE::Tools qw(extract_param);
+use PVE::JSONSchema qw(get_standard_option);
+use PVE::RESTHandler;
+use PVE::Notify;
+
+use base qw(PVE::RESTHandler);
+
+sub make_properties_optional {
+ my ($properties) = @_;
+ $properties = dclone($properties);
+
+ for my $key (keys %$properties) {
+ $properties->{$key}->{optional} = 1 if $key ne 'name';
+ }
+
+ return $properties;
+}
+
+sub raise_api_error {
+ my ($api_error) = @_;
+
+ if (!(ref($api_error) eq 'HASH' && $api_error->{message} && $api_error->{code})) {
+ die $api_error;
+ }
+
+ my $msg = "$api_error->{message}\n";
+ my $exc = PVE::Exception->new($msg, code => $api_error->{code});
+
+ my (undef, $filename, $line) = caller;
+
+ $exc->{filename} = $filename;
+ $exc->{line} = $line;
+
+ die $exc;
+}
+
+__PACKAGE__->register_method ({
+ name => 'index',
+ path => '',
+ method => 'GET',
+ description => 'Index for notification-related API endpoints.',
+ permissions => { user => 'all' },
+ parameters => {
+ additionalProperties => 0,
+ properties => {},
+ },
+ returns => {
+ type => 'array',
+ items => {
+ type => 'object',
+ properties => {},
+ },
+ links => [ { rel => 'child', href => '{name}' } ],
+ },
+ code => sub {
+ my $result = [
+ ];
+
+ return $result;
+ }
+});
+
+1;
--
2.39.2
next prev parent reply other threads:[~2023-07-26 9:50 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-07-26 9:49 [pve-devel] [PATCH v5 many 00/30] fix #4156: introduce new notification system Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-ha-manager 01/30] manager: send notifications via new notification module Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 02/30] d/control: add dependency to `libpve-notify-perl` Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 03/30] vzdump: send notifications via new notification module Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 04/30] test: rename mail_test.pl to vzdump_notification_test.pl Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 05/30] api: apt: send notification via new notification module Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 06/30] api: replication: send notifications " Lukas Wagner
2023-07-26 9:49 ` Lukas Wagner [this message]
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 08/30] api: notification: add api routes for groups Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 09/30] api: notification: add api routes for sendmail endpoints Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 10/30] api: notification: add api routes for gotify endpoints Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 11/30] api: notification: add api routes for filters Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 12/30] api: notification: allow fetching notification targets Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 13/30] api: notification: allow to test targets Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 14/30] api: notification: disallow removing targets if they are used Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 15/30] ui: backup: allow to select notification target for jobs Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 16/30] ui: backup: adapt backup job details to new notification params Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 17/30] ui: backup: allow to set notification-target for one-off backups Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 18/30] ui: allow to configure notification event -> target mapping Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 19/30] ui: add notification target configuration panel Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 20/30] ui: perm path: add ACL paths for notifications, usb and pci mappings Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 21/30] ui: perm path: increase width of the perm path selector combobox Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 22/30] ui: dc: remove notify key from datacenter option view Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 23/30] vzdump: use <name> as a convention for virtual endpoints/groups Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 pve-manager 24/30] api: notification: make the 'mail-to-root' target visible to any user Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 25/30] notification: add gui for sendmail notification endpoints Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 26/30] notification: add gui for gotify " Lukas Wagner
2023-07-26 9:49 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 27/30] notification: add gui for notification groups Lukas Wagner
2023-07-26 9:50 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 28/30] notification: allow to select filter for notification targets Lukas Wagner
2023-07-26 9:50 ` [pve-devel] [PATCH v5 proxmox-widget-toolkit 29/30] notification: add ui for managing notification filters Lukas Wagner
2023-07-26 9:50 ` [pve-devel] [PATCH v5 pve-docs 30/30] add documentation for the new notification system Lukas Wagner
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=20230726095002.325276-8-l.wagner@proxmox.com \
--to=l.wagner@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.