my $pd = $d->{$p};
if ($p =~ m/^([a-z]+)(\d+)$/) {
my ($name, $idx) = ($1, $2);
- if ($idx == 0) {
+ if ($idx == 0 && defined($d->{"${name}1"})) {
$p = "${name}[n]";
} elsif (defined($d->{"${name}0"})) {
next; # only handle once for -xx0, but only if -xx0 exists
}
}
- $res->{$k}->{$p} = ref($pd) ? clone($pd) : $pd;
+ my $tmp = ref($pd) ? clone($pd) : $pd;
+ # NOTE: add typetext property for more complex types, to
+ # make the web api viewer code simpler
+ if (!(defined($tmp->{enum}) || defined($tmp->{pattern}))) {
+ my $typetext = PVE::JSONSchema::schema_get_type_text($tmp);
+ if ($tmp->{type} && ($tmp->{type} ne $typetext)) {
+ $tmp->{typetext} = $typetext;
+ }
+ }
+ $res->{$k}->{$p} = $tmp;
}
}
push @{$method_registry->{$self}}, $info;
}
-sub register_page_formatter {
- my ($self, %config) = @_;
-
- my $format = $config{format} ||
- die "missing format";
-
- my $path = $config{path} ||
- die "missing path";
-
- my $method = $config{method} ||
- die "missing method";
-
- my $code = $config{code} ||
- die "missing formatter code";
-
- my $uri_param = {};
- my ($handler, $info) = $self->find_handler($method, $path, $uri_param);
- die "unabe to find handler for '$method: $path'" if !($handler && $info);
-
- die "duplicate formatter for '$method: $path'"
- if $info->{formatter} && $info->{formatter}->{$format};
-
- $info->{formatter}->{$format} = $code;
-}
-
sub DESTROY {}; # avoid problems with autoload
sub AUTOLOAD {
# $display_name: for example "-$name" of "<$name>", pass undef to use "$name:"
# $phash: json schema property hash
# $format: 'asciidoc', 'short', 'long' or 'full'
-# $style: 'config', 'arg' or 'fixed'
+# $style: 'config', 'config-sub', 'arg' or 'fixed'
my $get_property_description = sub {
my ($name, $style, $phash, $format, $hidepw, $fileparams) = @_;
my $descr = $phash->{description} || "no description available";
+ if ($phash->{verbose_description} &&
+ ($style eq 'config' || $style eq 'config-sub')) {
+ $descr = $phash->{verbose_description};
+ }
+
chomp $descr;
- my $type = PVE::JSONSchema::schema_get_type_text($phash);
+ my $type_text = PVE::JSONSchema::schema_get_type_text($phash, $style);
if ($hidepw && $name eq 'password') {
- $type = '';
+ $type_text = '';
}
- if ($fileparams && $type eq 'string') {
+ if ($fileparams && $phash->{type} eq 'string') {
foreach my $elem (@$fileparams) {
if ($name eq $elem) {
- $type = 'filepath';
+ $type_text = '<filepath>';
last;
}
}
if ($style eq 'config') {
$res .= "`$name`: ";
+ } elsif ($style eq 'config-sub') {
+ $res .= "`$name`=";
} elsif ($style eq 'arg') {
- $res .= "`-$name` ";
+ $res .= "`--$name` ";
} elsif ($style eq 'fixed') {
- $res .= "`<$name>` ";
+ $res .= "`<$name>`: ";
} else {
die "unknown style '$style'";
}
- $res .= "`$type` " if $type;
+ $res .= "`$type_text` " if $type_text;
if (defined(my $dv = $phash->{default})) {
- $res .= "(default=`$dv`)";
+ $res .= "('default =' `$dv`)";
+ }
+
+ if ($style eq 'config-sub') {
+ $res .= ";;\n\n";
+ } else {
+ $res .= "::\n\n";
}
- $res .= "::\n\n";
- my $wdescr = Text::Wrap::wrap('', '', ($descr));
+ my $wdescr = $descr;
chomp $wdescr;
$wdescr =~ s/^$/+/mg;
die "unknown style '$style'";
}
- my $tmp = sprintf " %-10s %s$defaulttxt\n", $display_name, "$type";
+ my $tmp = sprintf " %-10s %s$defaulttxt\n", $display_name, "$type_text";
my $indend = " ";
$res .= Text::Wrap::wrap('', $indend, ($tmp));
next if $arg_hash->{$k};
next if defined($fixed_param->{$k});
- my $type = $prop->{$k}->{type} || 'string';
+ my $type_text = $prop->{$k}->{type} || 'string';
next if $hidepw && ($k eq 'password') && !$prop->{$k}->{optional};
if ($k =~ m/^([a-z]+)(\d+)$/) {
my ($name, $idx) = ($1, $2);
next if $idx_param->{$name};
- if ($idx == 0) {
+ if ($idx == 0 && defined($prop->{"${name}1"})) {
$idx_param->{$name} = 1;
$base = "${name}[n]";
}
if (!$prop->{$k}->{optional}) {
$args .= " " if $args;
- $args .= "-$base <$type>"
+ $args .= "--$base <$type_text>"
}
}
my $phash = $prop->{$k};
next if defined($filterFn) && &$filterFn($k, $phash);
-
- my $type = $phash->{type} || 'string';
+ next if $phash->{alias};
my $base = $k;
if ($k =~ m/^([a-z]+)(\d+)$/) {
my ($name, $idx) = ($1, $2);
next if $idx_param->{$name};
- if ($idx == 0) {
+ if ($idx == 0 && defined($prop->{"${name}1"})) {
$idx_param->{$name} = 1;
$base = "${name}[n]";
}
}
$raw .= &$get_property_description($base, $style, $phash, $format, 0);
+
+ next if $style ne 'config';
+
+ my $prop_fmt = $phash->{format};
+ next if !$prop_fmt;
+
+ if (ref($prop_fmt) ne 'HASH') {
+ $prop_fmt = PVE::JSONSchema::get_format($prop_fmt);
+ }
+
+ next if !(ref($prop_fmt) && (ref($prop_fmt) eq 'HASH'));
+
+ $raw .= dump_properties($prop_fmt, $format, 'config-sub')
+
}
return $raw;