From 7a46f389ed8c1416f9dc0c68791022150770682e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Marczykowski-G=C3=B3recki?= Date: Tue, 3 Dec 2019 06:22:24 +0100 Subject: [PATCH] Define property.GetAll methods Allow getting all the properties at once, to limit number of Admin API calls. Client should be prepared to handle the case when the call isn't available (too old version, refused by the policy etc) and fallback to getting properties one by one. --- developer/services/admin-api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/developer/services/admin-api.md b/developer/services/admin-api.md index a98d7224..8a85c7a0 100644 --- a/developer/services/admin-api.md +++ b/developer/services/admin-api.md @@ -73,6 +73,7 @@ to set the policy using current mechanism. | `admin.label.Remove` | `dom0` | label | - | - | | `admin.property.List` | `dom0` | - | - | `\n` | | `admin.property.Get` | `dom0` | property | - | `default={True|False} `
`type={str|int|bool|vm|label|list} ` | Type `list` is added in R4.1. Values are of type `str` and each entry is suffixed with newline character. +| `admin.property.GetAll` | `dom0` | - | - | ` \n` | Get all the properties in one call. Each property is returned on a separate line and use the same value encoding as property.Get method, with an exception that newlines are encoded as literal `\n` and literal `\` are encoded as `\\`. | `admin.property.GetDefault` | `dom0` | property | - | `type={str|int|bool|vm|label|list} ` | Type `list` is added in R4.1. Values are of type `str` and each entry is suffixed with newline character. | `admin.property.Help` | `dom0` | property | - | `help` | | `admin.property.HelpRst` | `dom0` | property | - | `help.rst` | @@ -80,6 +81,7 @@ to set the policy using current mechanism. | `admin.property.Set` | `dom0` | property | value | - | | `admin.vm.property.List` | vm | - | - | `\n` | | `admin.vm.property.Get` | vm | property | - | `default={True|False} `
`type={str|int|bool|vm|label|list} ` | Type `list` is added in R4.1. Each list entry is suffixed with a newline character. +| `admin.vm.property.GetAll` | vm | - | - | ` \n` | Get all the properties in one call. Each property is returned on a separate line and use the same value encoding as property.Get method, with an exception that newlines are encoded as literal `\n` and literal `\` are encoded as `\\`. | `admin.vm.property.GetDefault` | vm | property | - | `type={str|int|bool|vm|label|type} ` | Type `list` is added in R4.1. Each list entry is suffixed with a newline character. | `admin.vm.property.Help` | vm | property | - | `help` | | `admin.vm.property.HelpRst` | vm | property | - | `help.rst` |