Reviewed-by: Aline Manera <alinefm(a)linux.vnet.ibm.com>
On 02/10/2014 10:52 AM, Rodrigo Trujillo wrote:
This patch changes API.md with new storage
sub-collection/sub-resource
information.
Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com>
Signed-off-by: Rodrigo Trujillo <rodrigo.trujillo(a)linux.vnet.ibm.com>
---
docs/API.md | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)
diff --git a/docs/API.md b/docs/API.md
index 7f0628d..fb5ec17 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -117,6 +117,28 @@ Represents a snapshot of the Virtual Machine's primary monitor.
* **GET**: Redirect to the latest screenshot of a Virtual Machine in PNG format
+
+### Sub-collection: Virtual Machine storages
+**URI:** /vms/*:name*/storages
+* **GET**: Retrieve a summarized list of all storages of specified guest
+* **POST**: Attach a new storage to specified virtual machine.
+ Simulate add new cdrom
+ * dev : The name of the storage in the vm.
+ * type : The type of the storage (cdrom, disk).
+ * path : Path of cdrom iso or disk.
+
+### Sub-resource: storage
+**URI:** /vms/*:name*/storages/*:dev*
+* **GET**: Retrieve storage information
+ * dev : The name of the storage in the vm.
+ * type : The type of the storage (cdrom, disk).
+ * path : Path of cdrom iso or disk.
+* **PUT**: Update storage information
+ * path: Path of cdrom iso or disk.
+* **DELETE**: Remove the storage. Simulate eject a cdrom
+
+
+
### Collection: Templates
**URI:** /templates