[pve-devel] [PATCH storage 1/2] api: try to add more return schema information

[Dominik Csapak <d.csapak@proxmox.com>]

no problem for 'select_existing', but we cannot actually describe
'format' with our JSONSchema, since it uses an array as a form of tuple,
and even with oneOf this cannot be described currently.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---
 src/PVE/API2/Storage/Status.pm | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/PVE/API2/Storage/Status.pm b/src/PVE/API2/Storage/Status.pm
index 7bde4ec..ff32782 100644
--- a/src/PVE/API2/Storage/Status.pm
+++ b/src/PVE/API2/Storage/Status.pm
@@ -171,6 +171,23 @@ __PACKAGE__->register_method({
                     renderer => 'fraction_as_percentage',
                     optional => 1,
                 },
+                select_existing => {
+                    description => "Instead of creating new volumes, one must select one that"
+                        . " is already existing. Only included if 'format' parameter is set.",
+                    type => 'boolean',
+                    optional => 1,
+                },
+
+                # we can't include this return schema, since we cannot properly
+                # describe what it actually is with the json schema:
+                #
+                # a tuple in form of an array where the first element is an
+                # object, and the second is a string.
+                #format => {
+                #    description => "Lists the supported and default format."
+                #        . " Only included if 'format' parameter is set.",
+                #    optional => 1,
+                #},
             },
         },
         links => [{ rel => 'child', href => "{storage}" }],
-- 
2.47.3



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel