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

[Hongliang Wang]

On 02/17/2014 03:46 PM, Sheldon wrote:
> On 02/13/2014 10:07 PM, Aline Manera wrote:
>> From: Paulo Vital <pvital at linux.vnet.ibm.com>
>>
>> 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 |   31 +++++++++++++++++++++++++++++++
>>   1 file changed, 31 insertions(+)
>>
>> diff --git a/docs/API.md b/docs/API.md
>> index 48a293f..9b4e2fd 100644
>> --- a/docs/API.md
>> +++ b/docs/API.md
>> @@ -744,3 +744,34 @@ 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 and return a 
>> Task resource
>> +    * task resource.  * See Resource: Task *
> This collection is different from other collections.
> It support an action on collection.
>
Yes, sounds somewhat confusing.

     The URI /host/packagesupdate/update is in resource format and I 
thought it is a package named "update".

     POST /host/packagesupdate/update is supposed to create some 
property to package "update".

     We've seen other product defining actions to a collection using 
predefined keywords as:

     /host/packagesupdate/ALL

     F.Y.I.
>> +
>> +### Resource: Host Package Update
>> +
>> +**URI:** /host/packagesupdate/*: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
>
>