Change in vdsm[master]: fix the optional parameters error of api schema file

shaohef at linux.vnet.ibm.com shaohef at linux.vnet.ibm.com
Fri Dec 28 06:29:44 UTC 2012


ShaoHe Feng has uploaded a new change for review.

Change subject: fix the optional parameters error of api schema file
......................................................................

fix the optional parameters error of api schema file

some discrptions of optional parameters miss #optional
some definitions of optional parameters miss *

Change-Id: Ia596c38bcb46aa0798ac2147376e9132be292750
Signed-off-by: ShaoHe Feng <shaohef at linux.vnet.ibm.com>
---
M vdsm_api/vdsmapi-schema.json
1 file changed, 12 insertions(+), 12 deletions(-)


  git pull ssh://gerrit.ovirt.org:29418/vdsm refs/changes/47/10447/1

diff --git a/vdsm_api/vdsmapi-schema.json b/vdsm_api/vdsmapi-schema.json
index 8837409..cfde542 100644
--- a/vdsm_api/vdsmapi-schema.json
+++ b/vdsm_api/vdsmapi-schema.json
@@ -294,9 +294,9 @@
 #
 # @action:    The type of fencing operation to perform (from @FenceNodeAction)
 #
-# @secure:    Enable SSL communication
+# @secure:    #optional Enable SSL communication
 #
-# @options:   Additional agent-specific parameters in space-separated
+# @options:   #optional Additional agent-specific parameters in space-separated
 #             <var>=<val> pairs
 #
 # Returns:
@@ -2429,7 +2429,7 @@
 #                         are reserved for host-passthrough and host-mode cpu
 #                         mode
 #
-# @custom:                A dictionary of custom, free-form properties
+# @custom:                #optional A dictionary of custom, free-form properties
 #
 # @devices:               An array of VM devices present
 #
@@ -2480,7 +2480,7 @@
 ##
 {'type': 'VmDefinition',
  'data': {'acpiEnable': 'bool', 'clientIp': 'str', 'cpuType': 'str',
-          'custom': 'StringMap', 'devices': ['VmDevice'],
+          '*custom': 'StringMap', 'devices': ['VmDevice'],
           'display': 'VmDisplayType', 'displayIp': 'str',
           'displayPort': 'uint', 'displaySecurePort': 'uint',
           'emulatedMachine': 'str', 'keyboardLayout': 'str',
@@ -2498,7 +2498,7 @@
 #
 # @acpiEnable:            Indicates if ACPI is enabled inside the VM
 #
-# @custom:                #opional A dictionary of custom, free-form properties
+# @custom:                #optional A dictionary of custom, free-form properties
 #
 # @devices:               #optional An array of VM devices requested
 #
@@ -2982,9 +2982,9 @@
 #
 # @volumeList:       A list of Volume UUIDs
 #
-# @postZero:         If True, overwrite Volume data with zeroes after deletion
+# @postZero:         #optional If True, overwrite Volume data with zeroes after deletion
 #
-# @force:            Force the operation and do not perform any validation
+# @force:            #optional Force the operation and do not perform any validation
 #
 # Returns:
 # A task UUID
@@ -4261,9 +4261,9 @@
 #
 # @enableScsiFencing:  This parameter is not used
 #
-# @maxHostID:          The maximum number of hosts that could be in the cluster
+# @maxHostID:          #optional The maximum number of hosts that could be in the cluster
 #
-# @domVersion:         The expected Storage Domain version of the master domain
+# @domVersion:         #optional The expected Storage Domain version of the master domain
 #
 # Returns:
 # A task UUID
@@ -5313,10 +5313,10 @@
 #
 # @dstparams:  Used only by the hibernate API.  Ignored for @remote migration
 #
-# @mode:       The migration mode.  Callers of this API should use @remote.  For
+# @mode:       #optional The migration mode.  Callers of this API should use @remote.  For
 #              @file migration use @VM.hibernate.
 #
-# @method:
+# @method:     #optional
 #
 # Since: 4.10.0
 ##
@@ -5499,7 +5499,7 @@
 # Since: 4.10.0
 ##
 {'command': {'class': 'VM', 'name': 'shutdown'},
- 'data': {'vmID': 'UUID', 'delay': 'int', 'message': 'str'}}
+ 'data': {'vmID': 'UUID', '*delay': 'int', '*message': 'str'}}
 
 ##
 # @SnapshotVolumeDriveInfo:


--
To view, visit http://gerrit.ovirt.org/10447
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: Ia596c38bcb46aa0798ac2147376e9132be292750
Gerrit-PatchSet: 1
Gerrit-Project: vdsm
Gerrit-Branch: master
Gerrit-Owner: ShaoHe Feng <shaohef at linux.vnet.ibm.com>


More information about the vdsm-patches mailing list