pve-manager/PVE/API2.pm
Thomas Lamprecht 3ce05d40af api: version: expand return schema info
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2021-11-10 17:34:39 +01:00

134 lines
2.8 KiB
Perl

package PVE::API2;
use strict;
use warnings;
use PVE::pvecfg;
use PVE::DataCenterConfig;
use PVE::RESTHandler;
use PVE::JSONSchema;
use base qw(PVE::RESTHandler);
# preload classes
use PVE::API2::Cluster;
use PVE::API2::Nodes;
use PVE::API2::Pool;
use PVE::API2::AccessControl;
use PVE::API2::Storage::Config;
__PACKAGE__->register_method ({
subclass => "PVE::API2::Cluster",
path => 'cluster',
});
__PACKAGE__->register_method ({
subclass => "PVE::API2::Nodes",
path => 'nodes',
});
__PACKAGE__->register_method ({
subclass => "PVE::API2::Storage::Config",
path => 'storage',
});
__PACKAGE__->register_method ({
subclass => "PVE::API2::AccessControl",
path => 'access',
});
__PACKAGE__->register_method ({
subclass => "PVE::API2::Pool",
path => 'pools',
});
__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 {
my ($param) = @_;
my $res = [ { subdir => 'version' } ];
my $ma = PVE::API2->method_attributes();
foreach my $info (@$ma) {
next if !$info->{subclass};
my $subpath = $info->{match_re}->[0];
push @$res, { subdir => $subpath };
}
return $res;
}});
__PACKAGE__->register_method ({
name => 'version',
path => 'version',
method => 'GET',
permissions => { user => 'all' },
description => "API version details, including some parts of the global datacenter config.",
parameters => {
additionalProperties => 0,
properties => {},
},
returns => {
type => "object",
properties => {
version => {
type => 'string',
description => 'The full pve-manager package version of this node.',
},
release => {
type => 'string',
description => 'The current Proxmox VE point release in `x.y` format.',
},
repoid => {
type => 'string',
description => 'The short git revision from which this version was build.',
},
console => {
type => 'string',
enum => ['applet', 'vv', 'html5', 'xtermjs'],
optional => 1,
description => 'The default console viewer to use.',
},
},
},
code => sub {
my ($param) = @_;
my $res = {};
my $datacenter_confg = eval { PVE::Cluster::cfs_read_file('datacenter.cfg') } // {};
for my $k (qw(console)) {
$res->{$k} = $datacenter_confg->{$k} if exists $datacenter_confg->{$k};
}
my $version_info = PVE::pvecfg::version_info();
# force set all version keys independent of their definedness
$res->{$_} = $version_info->{$_} for qw(version release repoid);
return $res;
}});
1;