schema_get_type_text: render generic types as <type>

[pve-common.git] / src / PVE / RESTHandler.pm

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index 8d6f5779570826337f93c81d73f7f03e74771bf4..4b67c614f336c1fc52c1a70d0234847163aa6b95 100644 (file)
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -6,7 +6,6 @@ use warnings;
 use PVE::SafeSyslog;
 use PVE::Exception qw(raise raise_param_exc);
 use PVE::JSONSchema;
-use PVE::PodParser;
 use HTTP::Status qw(:constants :is status_message);
 use Text::Wrap;
 use Clone qw(clone);
@@ -34,13 +33,23 @@ sub api_clone_schema {
        foreach my $p (keys %$d) {
            my $pd = $d->{$p};
            if ($p =~ m/^([a-z]+)(\d+)$/) {
-               if ($2 == 0) {
-                   $p = "$1\[n\]";
-               } else {
-                   next;
+               my ($name, $idx) = ($1, $2);
+               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
+               }
+           }
+           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} = ref($pd) ? clone($pd) : $pd;
+           $res->{$k}->{$p} = $tmp;
        }
     }
 
@@ -407,7 +416,7 @@ sub handle {
 # $name: option name
 # $display_name: for example "-$name" of "<$name>", pass undef to use "$name:"
 # $phash: json schema property hash
-# $format: 'asciidoc', 'pod' or 'text'
+# $format: 'asciidoc', 'short', 'long' or 'full'
 # $style: 'config', 'arg' or 'fixed'
 my $get_property_description = sub {
     my ($name, $style, $phash, $format, $hidepw, $fileparams) = @_;
@@ -418,9 +427,14 @@ my $get_property_description = sub {
 
     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::PodParser::schema_get_type_text($phash);
+    my $type = PVE::JSONSchema::schema_get_type_text($phash);
 
     if ($hidepw && $name eq 'password') {
        $type = '';
@@ -429,7 +443,7 @@ my $get_property_description = sub {
     if ($fileparams && $type eq 'string') {
        foreach my $elem (@$fileparams) {
            if ($name eq $elem) {
-               $type = 'filepath';
+               $type = '<filepath>';
                last;
            }
        }
@@ -439,6 +453,8 @@ my $get_property_description = sub {
 
        if ($style eq 'config') {
            $res .= "`$name`: ";
+       } elsif ($style eq 'config-sub') {
+           $res .= "`$name`=";
        } elsif ($style eq 'arg') {
            $res .= "`-$name` ";
        } elsif ($style eq 'fixed') {
@@ -450,11 +466,16 @@ my $get_property_description = sub {
        $res .= "`$type` " if $type;
 
        if (defined(my $dv = $phash->{default})) {
-           $res .= "(default=`$dv`)";
+           $res .= "('default =' `$dv`)";
        }
-       $res .= "::\n\n";
 
-       my $wdescr = Text::Wrap::wrap('', '', ($descr));
+       if ($style eq 'config-sub') {
+           $res .= ";;\n\n";
+       } else {
+           $res .= "::\n\n";
+       }
+
+       my $wdescr = $descr;
        chomp $wdescr;
        $wdescr =~ s/^$/+/mg;
 
@@ -466,7 +487,7 @@ my $get_property_description = sub {
        }
        $res .= "\n";
 
-    } elsif ($format eq 'pod' || $format eq 'text') {
+    } elsif ($format eq 'short' || $format eq 'long' || $format eq 'full') {
 
        my $defaulttxt = '';
        if (defined(my $dv = $phash->{default})) {
@@ -512,9 +533,9 @@ my $get_property_description = sub {
 #                  on the command line (or single parameter name for lists)
 # $fixed_param ... do not generate and info about those parameters
 # $format:
-#   'long'     ... default (list all options)
-#   'short'    ... command line only (one line)
-#   'full'     ... also include description
+#   'long'     ... default (text, list all options)
+#   'short'    ... command line only (text, one line)
+#   'full'     ... text, include description
 #   'asciidoc' ... generate asciidoc for man pages (like 'full')
 # $hidepw      ... hide password option (use this if you provide a read passwork callback)
 # $stringfilemap ... mapping for string parameters to file path parameters
@@ -552,7 +573,7 @@ sub usage_str {
     foreach my $k (@$arg_param) {
        next if defined($fixed_param->{$k}); # just to be sure
        next if !$prop->{$k}; # just to be sure
-       $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, 'text', 0);
+       $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
     }
 
     my $idx_param = {}; # -vlan\d+ -scsi\d+
@@ -568,14 +589,16 @@ sub usage_str {
 
        my $base = $k;
        if ($k =~ m/^([a-z]+)(\d+)$/) {
-           my $name = $1;
+           my ($name, $idx) = ($1, $2);
            next if $idx_param->{$name};
-           $idx_param->{$name} = 1;
-           $base = "${name}[n]";
+           if ($idx == 0 && defined($prop->{"${name}1"})) {
+               $idx_param->{$name} = 1;
+               $base = "${name}[n]";
+           }
        }
 
        my $mapping = defined($stringfilemap) ? &$stringfilemap($name) : undef;
-       $opts .= &$get_property_description($base, 'arg', $prop->{$k}, 'text',
+       $opts .= &$get_property_description($base, 'arg', $prop->{$k}, $format,
                                            $hidepw, $mapping);
 
        if (!$prop->{$k}->{optional}) {
@@ -627,19 +650,35 @@ sub dump_properties {
        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 = $1;
+           my ($name, $idx) = ($1, $2);
            next if $idx_param->{$name};
-           $idx_param->{$name} = 1;
-           $base = "${name}[n]";
+           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;
 }