+__PACKAGE__->register_method ({
+ name => 'pveclient_usage',
+ path => 'pveclient_usage',
+ method => 'GET',
+ description => "print API usage information for <api_path>.",
+ parameters => {
+ additionalProperties => 0,
+ properties => {
+ api_path => $api_path_property,
+ verbose => {
+ description => "Verbose output format.",
+ type => 'boolean',
+ optional => 1,
+ },
+ returns => {
+ description => "Including schema for returned data.",
+ type => 'boolean',
+ optional => 1,
+ },
+ command => {
+ description => "API command.",
+ type => 'string',
+ enum => [ keys %$PVE::APIClient::Helpers::method_map ],
+ optional => 1,
+ },
+ },
+ },
+ returns => { type => 'null' },
+ code => sub {
+ my ($param) = @_;
+
+ my $path = $param->{api_path};
+
+ my $found = 0;
+ foreach my $cmd (qw(get set create delete)) {
+ next if $param->{command} && $cmd ne $param->{command};
+ my $method = $PVE::APIClient::Helpers::method_map->{$cmd};
+ my $uri_param = {};
+ my $info = PVE::APIClient::Helpers::find_method_info($path, $method, $uri_param, 1);
+ next if !$info;
+ $found = 1;
+
+ my $prefix = "pveclient api $cmd <remote> $path";
+ if ($param->{verbose}) {
+ print PVE::APIClient::RESTHandler::getopt_usage(
+ $info, $prefix, undef, $uri_param, 'full');
+
+ } else {
+ print "USAGE: " . PVE::APIClient::RESTHandler::getopt_usage(
+ $info, $prefix, undef, $uri_param, 'short');
+ }
+ if ($param-> {returns}) {
+ my $schema = to_json($info->{returns}, {utf8 => 1, canonical => 1, pretty => 1 });
+ print "RETURNS: $schema\n";
+ }
+ }
+
+ if (!$found) {
+ if ($param->{command}) {
+ die "no '$param->{command}' handler for '$path'\n";
+ } else {
+ die "no such resource '$path'\n"
+ }
+ }
+
+ return undef;
+ }});