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

[Aline Manera]

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

On 02/11/2014 03:28 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 | 30 ++++++++++++++++++++++++++++++
>   1 file changed, 30 insertions(+)
>
> diff --git a/docs/API.md b/docs/API.md
> index 580728c..eef107a 100644
> --- a/docs/API.md
> +++ b/docs/API.md
> @@ -741,3 +741,33 @@ 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.
> +
> +### Collection: Host Packages Update
> +
> +**URI:** /host/packagesupdate
> +
> +Contains the information and action of packages update in the host.
> +
> +**Methods:**
> +
> +* **GET**: Retrieves a list of all packages to be updated in the host:
> +
> +* **POST**: *See Software Update Actions*
> +
> +**Actions (POST):**
> +
> +* update: Start the update of packages in background
> +
> +### Resource: Host Package Update
> +
> +**URI:** /host/packageupdate/*:name*
> +
> +Contains the information for a specific package to be updated.
> +
> +**Methods:**
> +
> +* **GET**: Retrieves a full description of a package:
> +    * package_name: 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