From: Royce Lv <lvroyce(a)linux.vnet.ibm.com>
Update doc to support storage volume reference count.
Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com>
---
docs/API.md | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/API.md b/docs/API.md
index 89acd44..beb4186 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -368,6 +368,12 @@ A interface represents available network interface on VM.
* os_distro *(optional)*: os distribution of the volume, for iso volume only.
* os_version *(optional)*: os version of the volume, for iso volume only.
* bootable *(optional)*: True if iso image is bootable and not corrupted.
+ * ref_count: Number of vms which used this volume,
+ -1 for unknown referrence count,
+ which means volume's belonged to vm or created outside kimchi scope
+ and cannot be attached to other vms.
+ 0 for volumes which are available for attachment.
+ >1 indicate number of vms used this volume.
* **DELETE**: Remove the Storage Volume
* **POST**: *See Storage Volume Actions*
--
1.8.1.2