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

[Aline Manera]

On 02/10/2014 02:19 PM, Aline Manera wrote:
> On 02/10/2014 12:50 AM, 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 | 21 +++++++++++++++++++++
>>   1 file changed, 21 insertions(+)
>>
>> diff --git a/docs/API.md b/docs/API.md
>> index 580728c..d45298e 100644
>> --- a/docs/API.md
>> +++ b/docs/API.md
>> @@ -741,3 +741,24 @@ 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 Package Update
>> +
>> +**URI:** /host/packageupdate
>> +
>
> You will have the Resource and Collection
>
> /host/packageupdate = Resource
> /host/packagesupdates = Collection
>
> The Collection return a list of Resources
> And the Resource returns the data
>
> ### Collection: Host packages to be updated
>
> **URI:** /host/packagesupdate
>
> **Methods:**
>
> * **GET**: Retrieve a summarized list of all defined Virtual Machines
>

I forgot to add the action to Collection as all packages will be updates 
at once

* **POST**: *See Host Packages Update Actions*

**Actions (POST):**

* update: Update all packages set to be updated

> ### Resource: Host package set to be update
>
> **URI:** /host/packageupdate/*:name*
>
> **Methods:**
>
> * **GET**: Retrieve the full description of a package
>     * name: ...
>     * arch: ...
>     * version: ...
>     * repository: ...
>
>> +Contains the information and action of package/software update in 
>> the host.
>> +
>> +**Methods:**
>> +
>> +* **GET**: Retrieves a list of all packages to be updated in the host.
>> +    * 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 of packages in background
>
> _______________________________________________
> Kimchi-devel mailing list
> Kimchi-devel at ovirt.org
> http://lists.ovirt.org/mailman/listinfo/kimchi-devel
>