[Kimchi-devel] [PATCHv3 2/5] Add volume ref_cnt: update api.md

[Aline Manera]

On 02/25/2014 05:35 AM, lvroyce at linux.vnet.ibm.com wrote:
> From: Royce Lv <lvroyce at linux.vnet.ibm.com>
>
> Update doc to support storage volume reference count.
>
> Signed-off-by: Royce Lv <lvroyce at linux.vnet.ibm.com>
> ---
>   docs/API.md | 3 +++
>   1 file changed, 3 insertions(+)
>
> diff --git a/docs/API.md b/docs/API.md
> index e97eace..e3f9ae1 100644
> --- a/docs/API.md
> +++ b/docs/API.md
> @@ -395,6 +395,9 @@ 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_cnt: Number of vms which used this volume,

> +                 0 for volumes which are available for attachment.
> +                 >1 indicate number of vms used this volume.

Is the number of vms important?
Why not only true or false?

in_use: True|False

>
>   * **DELETE**: Remove the Storage Volume
>   * **POST**: *See Storage Volume Actions*