From: "Max R. Carrara" <m.carrara@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [PATCH pve-manager v2 14/17] api: add API routes 'plugins' and 'plugins/storage'
Date: Fri, 17 Jul 2026 17:49:21 +0200 [thread overview]
Message-ID: <20260717154943.696411-15-m.carrara@proxmox.com> (raw)
In-Reply-To: <20260717154943.696411-1-m.carrara@proxmox.com>
Add the `plugins` route to our API and handle it via its own module,
`API2/Plugins.pm`. Implement a GET endpoint for this route, which just
lists its subpaths.
Additionally, add the `plugins/storage` path to the API and let all
corresponding endpoints be handled by the
`PVE::API2::Plugins::Storage` module, which is part of the
`libpve-storage-perl` package.
This means that the following routes are now available:
* plugins
* plugins/storage
* plugins/storage/plugin
* plugins/storage/plugin/{type}
Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
PVE/API2.pm | 6 +++++
PVE/API2/Makefile | 1 +
PVE/API2/Plugins.pm | 61 +++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 68 insertions(+)
create mode 100644 PVE/API2/Plugins.pm
diff --git a/PVE/API2.pm b/PVE/API2.pm
index 0c7e4654..af1cf38b 100644
--- a/PVE/API2.pm
+++ b/PVE/API2.pm
@@ -17,6 +17,7 @@ use PVE::API2::Nodes;
use PVE::API2::Pool;
use PVE::API2::AccessControl;
use PVE::API2::Storage::Config;
+use PVE::API2::Plugins;
__PACKAGE__->register_method({
subclass => "PVE::API2::Cluster",
@@ -43,6 +44,11 @@ __PACKAGE__->register_method({
path => 'pools',
});
+__PACKAGE__->register_method({
+ subclass => "PVE::API2::Plugins",
+ path => 'plugins',
+});
+
__PACKAGE__->register_method({
name => 'index',
path => '',
diff --git a/PVE/API2/Makefile b/PVE/API2/Makefile
index 97f1cc20..97910009 100644
--- a/PVE/API2/Makefile
+++ b/PVE/API2/Makefile
@@ -17,6 +17,7 @@ PERLSOURCE = \
Network.pm \
NodeConfig.pm \
Nodes.pm \
+ Plugins.pm \
Pool.pm \
Replication.pm \
ReplicationConfig.pm \
diff --git a/PVE/API2/Plugins.pm b/PVE/API2/Plugins.pm
new file mode 100644
index 00000000..beb606e6
--- /dev/null
+++ b/PVE/API2/Plugins.pm
@@ -0,0 +1,61 @@
+package PVE::API2::Plugins;
+
+use v5.36;
+
+use PVE::RESTHandler;
+use base qw(PVE::RESTHandler);
+
+use PVE::API2::Plugins::Storage;
+
+__PACKAGE__->register_method({
+ subclass => "PVE::API2::Plugins::Storage",
+ path => 'storage',
+});
+
+__PACKAGE__->register_method({
+ name => 'index',
+ path => '',
+ method => 'GET',
+ permissions => {
+ user => 'all',
+ },
+ description => "Directory index.",
+ parameters => {
+ additionalProperties => 0,
+ properties => {},
+ },
+ returns => {
+ type => 'array',
+ items => {
+ type => 'object',
+ properties => {
+ subdir => {
+ type => 'string',
+ },
+ },
+ },
+ links => [
+ {
+ rel => 'child',
+ href => "{subdir}",
+ },
+ ],
+ },
+ code => sub($param) {
+ my $result = [];
+
+ my $attrs = PVE::API2::Plugins->method_attributes();
+
+ for my $info ($attrs->@*) {
+ next if !$info->{subclass};
+
+ my $subpath = $info->{match_re}->[0];
+
+ push $result->@*, { subdir => $subpath };
+ }
+
+ return $result;
+ },
+});
+
+1;
--
2.47.3
next prev parent reply other threads:[~2026-07-17 15:52 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-17 15:49 [PATCH common/manager/proxmox-widget-toolkit/storage v2 00/17] GUI Support for Custom Storage Plugins Max R. Carrara
2026-07-17 15:49 ` [PATCH pve-common v2 01/17] json schema: add multiline string format Max R. Carrara
2026-07-17 15:49 ` [RFC pve-common v2 02/17] jsonschema: support 'patternProperties' and allow 'x-' keywords Max R. Carrara
2026-07-20 12:01 ` Jakob Klocker
2026-07-17 15:49 ` [PATCH pve-storage v2 03/17] api: plugins/storage: add initial routes and endpoints Max R. Carrara
2026-07-20 12:17 ` Jakob Klocker
2026-07-20 12:21 ` Jakob Klocker
2026-07-17 15:49 ` [PATCH pve-storage v2 04/17] api: plugins/storage/plugin: include schema in plugin metadata Max R. Carrara
2026-07-17 15:49 ` [PATCH pve-storage v2 05/17] api: plugins/storage/plugin: mark sensitive properties in schema Max R. Carrara
2026-07-17 15:49 ` [PATCH pve-storage v2 06/17] api: plugins/storage/plugin: factor plugin metadata code into helper Max R. Carrara
2026-07-17 15:49 ` [PATCH pve-storage v2 07/17] api: plugins/storage/plugin: add plugins' 'content' to their metadata Max R. Carrara
2026-07-17 15:49 ` [PATCH pve-storage v2 08/17] all plugins: add 'title' to properties, adapt 'description's Max R. Carrara
2026-07-17 15:49 ` [RFC pve-storage v2 09/17] plugin: mark 'preallocation' and 'content-dirs' properties as advanced Max R. Carrara
2026-07-17 15:49 ` [RFC pve-storage v2 10/17] plugin, dirplugin: mark certain properties as hidden Max R. Carrara
2026-07-17 15:49 ` [PATCH proxmox-widget-toolkit v2 11/17] form: introduce new 'proxmoxtextarea' field Max R. Carrara
2026-07-17 15:49 ` [PATCH proxmox-widget-toolkit v2 12/17] utils: introduce helper function getFieldDefFromPropertySchema Max R. Carrara
2026-07-17 15:49 ` [PATCH proxmox-widget-toolkit v2 13/17] acme: use helper to construct ExtJS fields from property schemas Max R. Carrara
2026-07-17 15:49 ` Max R. Carrara [this message]
2026-07-20 12:26 ` [PATCH pve-manager v2 14/17] api: add API routes 'plugins' and 'plugins/storage' Jakob Klocker
2026-07-17 15:49 ` [PATCH pve-manager v2 15/17] ui: storage view: display error when no editor for storage type exists Max R. Carrara
2026-07-17 15:49 ` [PATCH pve-manager v2 16/17] ui: storage: add basic UI integration for custom storage plugins Max R. Carrara
2026-07-17 15:49 ` [RFC pve-manager v2 17/17] ui: storage: use property extension keywords for UI hints Max R. Carrara
2026-07-18 18:19 ` [PATCH common/manager/proxmox-widget-toolkit/storage v2 00/17] GUI Support for Custom Storage Plugins Ciro Iriarte
2026-07-21 9:24 ` Max R. Carrara
2026-07-20 12:48 ` Jakob Klocker
2026-07-21 9:09 ` Max R. Carrara
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=20260717154943.696411-15-m.carrara@proxmox.com \
--to=m.carrara@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.