Update API documentation

docs/api/v2/compute/vmware/projectsprojectidvmwarenodes.rst

@@ -13,8 +13,8 @@ Parameters
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: Instance created
+- **400**: Invalid request
 - **409**: Conflict
 
 Input
@@ -58,3 +58,9 @@ Output
     <tr><td>vmx_path</td>                    <td> </td>                     <td>string</td>                     <td>Path to the vmx file</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_post_projectsprojectidvmwarenodes.txt
+

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeid.rst

@@ -9,8 +9,8 @@ Get a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
@@ -40,6 +40,12 @@ Output
     <tr><td>vmx_path</td>                    <td> </td>                     <td>string</td>                     <td>Path to the vmx file</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_get_projectsprojectidvmwarenodesnodeid.txt
+
 
 PUT /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -47,8 +53,8 @@ Update a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
@@ -101,6 +107,12 @@ Output
     <tr><td>vmx_path</td>                    <td> </td>                     <td>string</td>                     <td>Path to the vmx file</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_put_projectsprojectidvmwarenodesnodeid.txt
+
 
 DELETE /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -108,12 +120,12 @@ Delete a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
+- **204**: Instance deleted
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Instance deleted
 

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.rst

@@ -9,17 +9,23 @@ Add a NIO to a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
-- **port_number**: Port on the adapter (always 0)
+- **node_id**: Node UUID
 - **adapter_number**: Adapter where the nio should be added
+- **port_number**: Port on the adapter (always 0)
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: NIO created
+- **400**: Invalid request
 - **404**: Instance doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.txt
+
 
 PUT /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -27,17 +33,23 @@ Update a NIO from a Virtualbox instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
-- **port_number**: Port from where the nio should be updated
+- **node_id**: Node UUID
 - **adapter_number**: Network adapter where the nio is located
+- **port_number**: Port from where the nio should be updated
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: NIO updated
+- **400**: Invalid request
 - **404**: Instance doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_put_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.txt
+
 
 DELETE /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -45,14 +57,20 @@ Remove a NIO from a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
-- **port_number**: Port on the adapter (always 0)
+- **node_id**: Node UUID
 - **adapter_number**: Adapter from where the nio should be removed
+- **port_number**: Port on the adapter (always 0)
 
 Response status codes
 **********************
+- **204**: NIO deleted
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: NIO deleted
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_delete_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdnio.txt
 

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst

@@ -9,10 +9,10 @@ Start a packet capture on a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
-- **port_number**: Port on the adapter (always 0)
+- **node_id**: Node UUID
 - **adapter_number**: Adapter to start a packet capture
+- **port_number**: Port on the adapter (always 0)
 
 Response status codes
 **********************

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst

@@ -9,14 +9,14 @@ Stop a packet capture on a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
-- **port_number**: Port on the adapter (always 0)
+- **node_id**: Node UUID
 - **adapter_number**: Adapter to stop a packet capture
+- **port_number**: Port on the adapter (always 0)
 
 Response status codes
 **********************
+- **204**: Capture stopped
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Capture stopped
 

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidinterfacesvmnet.rst

@@ -9,8 +9,8 @@ Allocate a VMware VMnet interface on the server
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidreload.rst

@@ -9,12 +9,18 @@ Reload a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
+- **204**: Instance reloaded
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Instance reloaded
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_post_projectsprojectidvmwarenodesnodeidreload.txt
 

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidresume.rst

@@ -9,12 +9,18 @@ Resume a suspended VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
+- **204**: Instance resumed
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Instance resumed
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_post_projectsprojectidvmwarenodesnodeidresume.txt
 

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstart.rst

@@ -9,12 +9,18 @@ Start a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
+- **204**: Instance started
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Instance started
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_post_projectsprojectidvmwarenodesnodeidstart.txt
 

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidstop.rst

@@ -9,12 +9,18 @@ Stop a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
+- **204**: Instance stopped
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Instance stopped
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_post_projectsprojectidvmwarenodesnodeidstop.txt
 

docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidsuspend.rst

@@ -9,12 +9,18 @@ Suspend a VMware VM instance
 
 Parameters
 **********
-- **node_id**: Node UUID
 - **project_id**: Project UUID
+- **node_id**: Node UUID
 
 Response status codes
 **********************
+- **204**: Instance suspended
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Instance suspended
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/compute_post_projectsprojectidvmwarenodesnodeidsuspend.txt