[Kimchi-devel] [PATCH 1/4] Host's software update: Update API.md

[Aline Manera]

Reviewed-by: Aline Manera <alinefm at linux.vnet.ibm.com>

On 01/27/2014 02:34 PM, Paulo Vital wrote:
> Define get and POST action update API for software update resource.
>
> Signed-off-by: Paulo Vital <pvital at linux.vnet.ibm.com>
> Signed-off-by: Ramon Medeiros <ramonn at linux.vnet.ibm.com>
> ---
>   docs/API.md | 20 ++++++++++++++++++++
>   1 file changed, 20 insertions(+)
>
> diff --git a/docs/API.md b/docs/API.md
> index 580728c..0ebc6b8 100644
> --- a/docs/API.md
> +++ b/docs/API.md
> @@ -741,3 +741,23 @@ Contains the host sample data.
>       * size: The total size of the partition, in bytes
>       * mountpoint: If the partition is mounted, represents the mountpoint.
>         Otherwise blank.
> +
> +### Resource: Host Software Update
> +
> +**URI:** /host/softwareupdate
> +
> +Contains the host's software update information and actions.
> +
> +**Methods:**
> +
> +* **GET**: Retrieve a list of packages to be updated in the format:
> +    * package: The name of the package to be updated
> +    * arch: The architecture of the package
> +    * version: The new version of the package
> +    * repository: The repository name from where package will be downloaded
> +
> +* **POST**: *See Software Update Actions*
> +
> +**Actions (POST):**
> +
> +* update: Start the update in background