Best shown with a example:
my $test_formatter = sub {
my ($res, $result_schema, $fmt_param) = @_;
PVE::CLIFormatter::print_api_result($res, $result_schema, undef, $fmt_param);
};
$cmddef = [ __PACKAGE__, 'test', [], undef, $test_formatter, $PVE::RESTHandler::standard_output_options],
# A real command is always an array consisting of its class, name, array of
# position fixed (required) parameters and hash of predefined parameters when
# mapping a CLI command t o an API call. Optionally an output method can be
# A real command is always an array consisting of its class, name, array of
# position fixed (required) parameters and hash of predefined parameters when
# mapping a CLI command t o an API call. Optionally an output method can be
-# passed at the end, e.g., for formatting or transformation purpose.
+# passed at the end, e.g., for formatting or transformation purpose, and
+# a schema of additional properties/arguments which are added to
+# the method schema and gets passed to the formatter.
#
# [class, name, fixed_params, API_pre-set params, output_sub ]
#
#
# [class, name, fixed_params, API_pre-set params, output_sub ]
#
foreach my $cmd (&$sortfunc($def)) {
if (ref($def->{$cmd}) eq 'ARRAY') {
foreach my $cmd (&$sortfunc($def)) {
if (ref($def->{$cmd}) eq 'ARRAY') {
- my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}};
+ my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @{$def->{$cmd}};
$str .= $separator if $oldclass && $oldclass ne $class;
$str .= $indent;
$str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
$str .= $separator if $oldclass && $oldclass ne $class;
$str .= $indent;
$str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
- $fixed_param, $format, $param_cb);
+ $fixed_param, $format, $param_cb, $formatter_properties);
$oldclass = $class;
} elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
$oldclass = $class;
} elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
- my ($class, $name, $arg_param, $fixed_param) = @$def;
+ my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @$def;
$abort->("unknown command '$cmd'") if !$class;
$str .= $indent;
$abort->("unknown command '$cmd'") if !$class;
$str .= $indent;
- $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb);
+ $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
- my ($class, $name, $arg_param, $uri_param) = @$def;
+ my ($class, $name, $arg_param, $uri_param, undef, $formatter_properties) = @$def;
$arg_param //= [];
$uri_param //= {};
$arg_param //= [];
$uri_param //= {};
my $info = $class->map_method_by_name($name);
my $info = $class->map_method_by_name($name);
- my $prop = $info->{parameters}->{properties};
+ my $prop = { %{$info->{parameters}->{properties}} }; # copy
+ $prop = { %$prop, %$formatter_properties } if $formatter_properties;
my $print_parameter_completion = sub {
my ($pname) = @_;
my $print_parameter_completion = sub {
my ($pname) = @_;
&$preparefunc() if $preparefunc;
&$preparefunc() if $preparefunc;
- my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
+ my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$def || []};
$abort->("unknown command '$cmd_str'") if !$class;
$abort->("unknown command '$cmd_str'") if !$class;
- my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb);
+ my ($res, $formatter_params) = $class->cli_handler(
+ $cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $formatter_properties);
if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns};
if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns};
- $outsub->($res, $result_schema);
+ $outsub->($res, $result_schema, $formatter_params);
}
};
my $handle_simple_cmd = sub {
my ($args, $preparefunc, $param_cb) = @_;
}
};
my $handle_simple_cmd = sub {
my ($args, $preparefunc, $param_cb) = @_;
- my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
+ my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$cmddef};
die "no class specified" if !$class;
if (scalar(@$args) >= 1) {
die "no class specified" if !$class;
if (scalar(@$args) >= 1) {
&$preparefunc() if $preparefunc;
&$preparefunc() if $preparefunc;
- my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $param_cb);
+ my ($res, $formatter_params) = $class->cli_handler(
+ $name, $name, \@ARGV, $arg_param, $uri_param, $param_cb, $formatter_properties);
if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns};
if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns};
- $outsub->($res, $result_schema);
+ $outsub->($res, $result_schema, $formatter_params);
# 'short' ... command line only (text, one line)
# 'full' ... text, include description
# 'asciidoc' ... generate asciidoc for man pages (like 'full')
# 'short' ... command line only (text, one line)
# 'full' ... text, include description
# 'asciidoc' ... generate asciidoc for man pages (like 'full')
-# $param_cb ... mapping for string parameters to file path parameters
+# $param_cb ... mapping for string parameters to file path parameters
+# $formatter_properties ... additional property definitions (passed to output formatter)
- my ($info, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_;
+ my ($info, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties) = @_;
$format = 'long' if !$format;
my $schema = $info->{parameters};
my $name = $info->{name};
$format = 'long' if !$format;
my $schema = $info->{parameters};
my $name = $info->{name};
- my $prop = $schema->{properties};
+ my $prop = { %{$schema->{properties}} }; # copy
+ $prop = { %$prop, %$formatter_properties } if $formatter_properties;
- my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_;
+ my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties) = @_;
my $info = $self->map_method_by_name($name);
my $info = $self->map_method_by_name($name);
- return getopt_usage($info, $prefix, $arg_param, $fixed_param, $format, $param_cb);
+ return getopt_usage($info, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
}
# generate docs from JSON schema properties
}
# generate docs from JSON schema properties
- my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $param_cb) = @_;
+ my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $param_cb, $formatter_properties) = @_;
my $info = $self->map_method_by_name($name);
my $info = $self->map_method_by_name($name);
eval {
my $param_map = {};
$param_map = $compute_param_mapping_hash->($param_cb->($name)) if $param_cb;
eval {
my $param_map = {};
$param_map = $compute_param_mapping_hash->($param_cb->($name)) if $param_cb;
- my $param = PVE::JSONSchema::get_options($info->{parameters}, $args, $arg_param, $fixed_param, $param_map);
+ my $schema = { %{$info->{parameters}} }; # copy
+ $schema->{properties} = { %{$schema->{properties}}, %$formatter_properties } if $formatter_properties;
+ my $param = PVE::JSONSchema::get_options($schema, $args, $arg_param, $fixed_param, $param_map);
+
+ if ($formatter_properties) {
+ foreach my $opt (keys %$formatter_properties) {
+ $fmt_param->{$opt} = delete $param->{$opt} if defined($param->{$opt});
+ }
+ }
if (defined($param_map)) {
$replace_file_names_with_contents->($param, $param_map);
if (defined($param_map)) {
$replace_file_names_with_contents->($param, $param_map);
die $err if !$ec || $ec ne "PVE::Exception" || !$err->is_param_exc();
die $err if !$ec || $ec ne "PVE::Exception" || !$err->is_param_exc();
- $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $param_cb);
+ $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $param_cb, $formatter_properties);
+ return wantarray ? ($res, $fmt_param) : $res;