[Kimchi-devel] [PATCH 2/8] Storage Pools: Update docs/API.md

[Royce Lv]

Reviewed-by: Royce Lv<lvroyce at linux.vnet.ibm.com>
I suggest we find a generic way to resolve this "enum" and "dependecy" 
problem, so that when one type is specified and need params to be 
required, things like json schema can check it.
On 01/13/2015 02:16 PM, Aline Manera wrote:
> 'adapter_name' is a required parameter for a SCSI FC pool.
> Also add 'persistent' parameter to storage pool information.
>
> Signed-off-by: Aline Manera <alinefm at linux.vnet.ibm.com>
> ---
>   docs/API.md | 5 ++++-
>   1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/docs/API.md b/docs/API.md
> index 67997ea..8c01c2f 100644
> --- a/docs/API.md
> +++ b/docs/API.md
> @@ -417,7 +417,7 @@ A interface represents available network interface on VM.
>                                Pool types: 'iscsi'.
>               * username: Login username of the iSCSI target.
>               * password: Login password of the iSCSI target.
> -        * adapter_name *(optional)*: Scsi host name.
> +        * adapter_name: Scsi host name.
>
>   ### Resource: Storage Pool
>
> @@ -444,9 +444,12 @@ A interface represents available network interface on VM.
>       * nr_volumes: The number of storage volumes for active pools, 0 for inactive pools
>       * autostart: Whether the storage pool will be enabled
>                    automatically when the system boots
> +    * persistent: True, when pool persist after a system reboot or be stopped.
> +                  All storage pools created by Kimchi are persistent.
>       * source: Source of the storage pool,
>           * addr: mount address of this storage pool(for 'netfs' pool)
>           * path: export path of this storage pool(for 'netfs' pool)
> +
>   * **PUT**: Set whether the Storage Pool should be enabled automatically when the
>              system boots
>       * autostart: Toggle the autostart flag of the VM. This flag sets whether