[Kimchi-devel] [PATCH 3/5] Storage volumes: Update docs/API.md

Aline Manera alinefm at linux.vnet.ibm.com
Thu Jan 22 14:36:51 UTC 2015


'type' is not a valid parameter to create a storage volume.
Also the 'format' parameter is only valid when creating a volume from
capacity.

Signed-off-by: Aline Manera <alinefm at linux.vnet.ibm.com>
---
 docs/API.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/API.md b/docs/API.md
index 5c4ccd3..3f7925f 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -476,10 +476,10 @@ A interface represents available network interface on VM.
             The return resource is a task resource * See Resource: Task *
             Only one of 'file', 'capacity', 'url' can be specified.
     * name: The name of the Storage Volume
-    * type: The type of the defined Storage Volume
     * capacity: The total space which can be used to store volumes
                 The unit is bytes
-    * format: The format of the defined Storage Volume
+    * format: The format of the defined Storage Volume. Only used when creating
+              a storage volume with 'capacity'.
     * file: File to be uploaded, passed through form data
     * url: URL to be downloaded
 
-- 
2.1.0




More information about the Kimchi-devel mailing list