Update API documentation

docs/api/v2/controller/appliance/appliances.rst

@@ -11,3 +11,9 @@ Response status codes
 **********************
 - **200**: Appliance list returned
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_appliances.txt
+

docs/api/v2/controller/appliance/appliancestemplates.rst

@@ -11,3 +11,9 @@ Response status codes
 **********************
 - **200**: Appliance template list returned
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_appliancestemplates.txt
+

docs/api/v2/controller/appliance/projectsprojectidappliancesapplianceid.rst

@@ -9,8 +9,8 @@ Create a node from an appliance
 
 Parameters
 **********
-- **appliance_id**: Appliance template UUID
 - **project_id**: Project UUID
+- **appliance_id**: Appliance template UUID
 
 Response status codes
 **********************

docs/api/v2/controller/compute/sendpointidemulatoraction.rst

@@ -0,0 +1,27 @@
+/v2/computes/endpoint/{compute_id}/{emulator}/{action:.+}
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v2/computes/endpoint/**{compute_id}**/**{emulator}**/**{action:.+}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Returns the endpoint for particular `compute` to specific action. WARNING: This is experimental feature and may change anytime. Please don't rely on this endpoint.
+
+Parameters
+**********
+- **compute_id**: Compute UUID
+
+Response status codes
+**********************
+- **200**: OK
+- **404**: Instance doesn't exist
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>endpoint</td>                    <td> </td>                     <td>string</td>                     <td>URL to endpoint on specific compute and to particular action</td>                     </tr>
+    </table>
+

docs/api/v2/controller/compute/sid.rst

@@ -84,7 +84,7 @@ Parameters
 
 Response status codes
 **********************
+- **204**: Instance deleted
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: Instance deleted
 

docs/api/v2/controller/compute/sidautoidlepc.rst

@@ -0,0 +1,17 @@
+/v2/computes/{compute_id}/auto_idlepc
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/computes/**{compute_id}**/auto_idlepc
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Compute IDLE PC value
+
+Parameters
+**********
+- **compute_id**: Compute UUID
+
+Response status codes
+**********************
+- **200**: Idle PC computed
+

docs/api/v2/controller/drawing/projectsprojectiddrawings.rst

@@ -15,6 +15,12 @@ Response status codes
 **********************
 - **200**: List of drawings returned
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectiddrawings.txt
+
 
 POST /v2/projects/**{project_id}**/drawings
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -26,8 +32,8 @@ Parameters
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: Drawing created
+- **400**: Invalid request
 
 Input
 *******
@@ -59,3 +65,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z property</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectiddrawings.txt
+

docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst

@@ -3,19 +3,56 @@
 
 .. contents::
 
-PUT /v2/projects/**{project_id}**/drawings/**{drawing_id}**
+GET /v2/projects/**{project_id}**/drawings/**{drawing_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Create a new drawing instance
+Get a drawing instance
 
 Parameters
 **********
-- **drawing_id**: Drawing UUID
 - **project_id**: Project UUID
+- **drawing_id**: Drawing UUID
 
 Response status codes
 **********************
+- **200**: Drawing found
 - **400**: Invalid request
+- **404**: Drawing doesn't exist
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>drawing_id</td>                    <td> </td>                     <td>string</td>                     <td>Drawing UUID</td>                     </tr>
+    <tr><td>project_id</td>                    <td> </td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>rotation</td>                    <td> </td>                     <td>integer</td>                     <td>Rotation of the element</td>                     </tr>
+    <tr><td>svg</td>                    <td> </td>                     <td>string</td>                     <td>SVG content of the drawing</td>                     </tr>
+    <tr><td>x</td>                    <td> </td>                     <td>integer</td>                     <td>X property</td>                     </tr>
+    <tr><td>y</td>                    <td> </td>                     <td>integer</td>                     <td>Y property</td>                     </tr>
+    <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z property</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectiddrawingsdrawingid.txt
+
+
+PUT /v2/projects/**{project_id}**/drawings/**{drawing_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Update a drawing instance
+
+Parameters
+**********
+- **project_id**: Project UUID
+- **drawing_id**: Drawing UUID
+
+Response status codes
+**********************
 - **201**: Drawing updated
+- **400**: Invalid request
 
 Input
 *******
@@ -47,6 +84,12 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z property</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_put_projectsprojectiddrawingsdrawingid.txt
+
 
 DELETE /v2/projects/**{project_id}**/drawings/**{drawing_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -54,11 +97,17 @@ Delete a drawing instance
 
 Parameters
 **********
-- **drawing_id**: Drawing UUID
 - **project_id**: Project UUID
+- **drawing_id**: Drawing UUID
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **204**: Drawing deleted
+- **400**: Invalid request
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectiddrawingsdrawingid.txt
 

docs/api/v2/controller/gns3_vm/gns3vm.rst

@@ -11,6 +11,12 @@ Response status codes
 **********************
 - **200**: GNS3 VM settings returned
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_gns3vm.txt
+
 
 PUT /v2/gns3vm
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -20,3 +26,9 @@ Response status codes
 **********************
 - **201**: GNS3 VM updated
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_put_gns3vm.txt
+

docs/api/v2/controller/gns3_vm/gns3vmengines.rst

@@ -11,3 +11,9 @@ Response status codes
 **********************
 - **200**: OK
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_gns3vmengines.txt
+

docs/api/v2/controller/gns3_vm/gns3vmenginesenginevms.rst

@@ -16,3 +16,9 @@ Response status codes
 - **200**: Success
 - **400**: Invalid request
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_gns3vmenginesenginevms.txt
+

docs/api/v2/controller/link/projectsprojectidlinks.rst

@@ -15,6 +15,12 @@ Response status codes
 **********************
 - **200**: List of links returned
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinks.txt
+
 
 POST /v2/projects/**{project_id}**/links
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -26,8 +32,8 @@ Parameters
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: Link created
+- **400**: Invalid request
 
 Input
 *******
@@ -63,3 +69,9 @@ Output
     <tr><td>suspend</td>                    <td> </td>                     <td>boolean</td>                     <td>Suspend the link</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinks.txt
+

docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst

@@ -3,19 +3,58 @@
 
 .. contents::
 
+GET /v2/projects/**{project_id}**/links/**{link_id}**
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Get a link instance
+
+Parameters
+**********
+- **project_id**: Project UUID
+- **link_id**: Link UUID
+
+Response status codes
+**********************
+- **200**: Link found
+- **400**: Invalid request
+- **404**: Link doesn't exist
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>capture_file_name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Read only property. The name of the capture file if capture is running</td>                     </tr>
+    <tr><td>capture_file_path</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Read only property. The full path of the capture file if capture is running</td>                     </tr>
+    <tr><td>capturing</td>                    <td> </td>                     <td>boolean</td>                     <td>Read only property. True if a capture running on the link</td>                     </tr>
+    <tr><td>filters</td>                    <td> </td>                     <td>object</td>                     <td>Packet filter. This allow to simulate latency and errors</td>                     </tr>
+    <tr><td>link_id</td>                    <td> </td>                     <td>string</td>                     <td>Link UUID</td>                     </tr>
+    <tr><td>link_type</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: ethernet, serial</td>                     </tr>
+    <tr><td>nodes</td>                    <td> </td>                     <td>array</td>                     <td>List of the VMS</td>                     </tr>
+    <tr><td>project_id</td>                    <td> </td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>suspend</td>                    <td> </td>                     <td>boolean</td>                     <td>Suspend the link</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinkslinkid.txt
+
+
 PUT /v2/projects/**{project_id}**/links/**{link_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Update a link instance
 
 Parameters
 **********
-- **link_id**: Link UUID
 - **project_id**: Project UUID
+- **link_id**: Link UUID
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: Link updated
+- **400**: Invalid request
 
 Input
 *******
@@ -51,6 +90,12 @@ Output
     <tr><td>suspend</td>                    <td> </td>                     <td>boolean</td>                     <td>Suspend the link</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_put_projectsprojectidlinkslinkid.txt
+
 
 DELETE /v2/projects/**{project_id}**/links/**{link_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -58,11 +103,17 @@ Delete a link instance
 
 Parameters
 **********
-- **link_id**: Link UUID
 - **project_id**: Project UUID
+- **link_id**: Link UUID
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **204**: Link deleted
+- **400**: Invalid request
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectidlinkslinkid.txt
 

docs/api/v2/controller/link/projectsprojectidlinkslinkidavailablefilters.rst

@@ -0,0 +1,25 @@
+/v2/projects/{project_id}/links/{link_id}/available_filters
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+GET /v2/projects/**{project_id}**/links/**{link_id}**/available_filters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Return the list of filters available for this link
+
+Parameters
+**********
+- **project_id**: Project UUID
+- **link_id**: Link UUID
+
+Response status codes
+**********************
+- **200**: List of filters
+- **400**: Invalid request
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinkslinkidavailablefilters.txt
+

docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst

@@ -9,8 +9,8 @@ Stream the pcap capture file
 
 Parameters
 **********
-- **link_id**: Link UUID
 - **project_id**: Project UUID
+- **link_id**: Link UUID
 
 Response status codes
 **********************

docs/api/v2/controller/link/projectsprojectidlinkslinkidstartcapture.rst

@@ -9,13 +9,13 @@ Start capture on a link instance. By default we consider it as an Ethernet link
 
 Parameters
 **********
-- **link_id**: Link UUID
 - **project_id**: Project UUID
+- **link_id**: Link UUID
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: Capture started
+- **400**: Invalid request
 
 Input
 *******
@@ -44,3 +44,9 @@ Output
     <tr><td>suspend</td>                    <td> </td>                     <td>boolean</td>                     <td>Suspend the link</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt
+

docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst

@@ -9,11 +9,17 @@ Stop capture on a link instance
 
 Parameters
 **********
-- **link_id**: Link UUID
 - **project_id**: Project UUID
+- **link_id**: Link UUID
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: Capture stopped
+- **400**: Invalid request
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt
 

docs/api/v2/controller/node/projectsprojectidnodes.rst

@@ -13,8 +13,8 @@ Parameters
 
 Response status codes
 **********************
-- **400**: Invalid request
 - **201**: Instance created
+- **400**: Invalid request
 
 Input
 *******
@@ -78,6 +78,12 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodes.txt
+
 
 GET /v2/projects/**{project_id}**/nodes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -91,3 +97,9 @@ Response status codes
 **********************
 - **200**: List of nodes returned
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodes.txt
+

docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst

@@ -44,6 +44,12 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeid.txt
+
 
 PUT /v2/projects/**{project_id}**/nodes/**{node_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -117,6 +123,12 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_put_projectsprojectidnodesnodeid.txt
+
 
 DELETE /v2/projects/**{project_id}**/nodes/**{node_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -124,12 +136,18 @@ Delete a node 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
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectidnodesnodeid.txt
 

docs/api/v2/controller/node/projectsprojectidnodesnodeidduplicate.rst

@@ -0,0 +1,68 @@
+/v2/projects/{project_id}/nodes/{node_id}/duplicate
+------------------------------------------------------------------------------------------------------------------------------------------
+
+.. contents::
+
+POST /v2/projects/**{project_id}**/nodes/**{node_id}**/duplicate
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Duplicate a node instance
+
+Parameters
+**********
+- **project_id**: Project UUID
+- **node_id**: Node UUID
+
+Response status codes
+**********************
+- **201**: Instance duplicated
+- **400**: Invalid request
+- **404**: Instance doesn't exist
+
+Input
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>x</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>X position of the node</td>                     </tr>
+    <tr><td>y</td>                    <td>&#10004;</td>                     <td>integer</td>                     <td>Y position of the node</td>                     </tr>
+    <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
+    </table>
+
+Output
+*******
+.. raw:: html
+
+    <table>
+    <tr>                 <th>Name</th>                 <th>Mandatory</th>                 <th>Type</th>                 <th>Description</th>                 </tr>
+    <tr><td>command_line</td>                    <td> </td>                     <td>['null', 'string']</td>                     <td>Command line use to start the node</td>                     </tr>
+    <tr><td>compute_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Compute identifier</td>                     </tr>
+    <tr><td>console</td>                    <td> </td>                     <td>['integer', 'null']</td>                     <td>Console TCP port</td>                     </tr>
+    <tr><td>console_host</td>                    <td> </td>                     <td>string</td>                     <td>Console host. Warning if the host is 0.0.0.0 or :: (listen on all interfaces) you need to use the same address you use to connect to the controller.</td>                     </tr>
+    <tr><td>console_type</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: vnc, telnet, http, https, spice, null</td>                     </tr>
+    <tr><td>first_port_name</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Name of the first port</td>                     </tr>
+    <tr><td>height</td>                    <td> </td>                     <td>integer</td>                     <td>Height of the node (Read only)</td>                     </tr>
+    <tr><td>label</td>                    <td> </td>                     <td>object</td>                     <td></td>                     </tr>
+    <tr><td>name</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Node name</td>                     </tr>
+    <tr><td>node_directory</td>                    <td> </td>                     <td>['null', 'string']</td>                     <td>Working directory of the node. Read only</td>                     </tr>
+    <tr><td>node_id</td>                    <td> </td>                     <td>string</td>                     <td>Node UUID</td>                     </tr>
+    <tr><td>node_type</td>                    <td>&#10004;</td>                     <td>enum</td>                     <td>Possible values: cloud, nat, ethernet_hub, ethernet_switch, frame_relay_switch, atm_switch, docker, dynamips, vpcs, virtualbox, vmware, iou, qemu</td>                     </tr>
+    <tr><td>port_name_format</td>                    <td> </td>                     <td>string</td>                     <td>Formating for port name {0} will be replace by port number</td>                     </tr>
+    <tr><td>port_segment_size</td>                    <td> </td>                     <td>integer</td>                     <td>Size of the port segment</td>                     </tr>
+    <tr><td>ports</td>                    <td> </td>                     <td>array</td>                     <td>List of node ports READ only</td>                     </tr>
+    <tr><td>project_id</td>                    <td> </td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
+    <tr><td>properties</td>                    <td> </td>                     <td>object</td>                     <td>Properties specific to an emulator</td>                     </tr>
+    <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: stopped, started, suspended</td>                     </tr>
+    <tr><td>symbol</td>                    <td> </td>                     <td>['string', 'null']</td>                     <td>Symbol of the node</td>                     </tr>
+    <tr><td>width</td>                    <td> </td>                     <td>integer</td>                     <td>Width of the node (Read only)</td>                     </tr>
+    <tr><td>x</td>                    <td> </td>                     <td>integer</td>                     <td>X position of the node</td>                     </tr>
+    <tr><td>y</td>                    <td> </td>                     <td>integer</td>                     <td>Y position of the node</td>                     </tr>
+    <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
+    </table>
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidduplicate.txt
+

docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst

@@ -9,12 +9,18 @@ Compute the IDLE PC for a Dynamips node
 
 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/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt
 

docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst

@@ -9,12 +9,18 @@ Compute a list of potential idle PC for a node
 
 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/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt
 

docs/api/v2/controller/node/projectsprojectidnodesnodeidfilespath.rst

@@ -9,14 +9,14 @@ Get a file in the node directory
 
 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
 
 
 POST /v2/projects/**{project_id}**/nodes/**{node_id}**/files/**{path:.+}**
@@ -25,12 +25,12 @@ Write a file in the node directory
 
 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
 

docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst

@@ -9,14 +9,14 @@ Reload a node 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
 
 Output
 *******
@@ -49,3 +49,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidreload.txt
+

docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst

@@ -9,14 +9,14 @@ Start a node 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
 
 Output
 *******
@@ -49,3 +49,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstart.txt
+

docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst

@@ -9,14 +9,14 @@ Stop a node 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
 
 Output
 *******
@@ -49,3 +49,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidstop.txt
+

docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst

@@ -9,14 +9,14 @@ Suspend a node 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
 
 Output
 *******
@@ -49,3 +49,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesnodeidsuspend.txt
+

docs/api/v2/controller/node/projectsprojectidnodesreload.rst

@@ -13,9 +13,9 @@ Parameters
 
 Response status codes
 **********************
+- **204**: All nodes successfully reloaded
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: All nodes successfully reloaded
 
 Output
 *******
@@ -48,3 +48,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesreload.txt
+

docs/api/v2/controller/node/projectsprojectidnodesstart.rst

@@ -13,9 +13,9 @@ Parameters
 
 Response status codes
 **********************
+- **204**: All nodes successfully started
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: All nodes successfully started
 
 Output
 *******
@@ -48,3 +48,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstart.txt
+

docs/api/v2/controller/node/projectsprojectidnodesstop.rst

@@ -13,9 +13,9 @@ Parameters
 
 Response status codes
 **********************
+- **204**: All nodes successfully stopped
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: All nodes successfully stopped
 
 Output
 *******
@@ -48,3 +48,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodesstop.txt
+

docs/api/v2/controller/node/projectsprojectidnodessuspend.rst

@@ -13,9 +13,9 @@ Parameters
 
 Response status codes
 **********************
+- **204**: All nodes successfully suspended
 - **400**: Invalid request
 - **404**: Instance doesn't exist
-- **204**: All nodes successfully suspended
 
 Output
 *******
@@ -48,3 +48,9 @@ Output
     <tr><td>z</td>                    <td> </td>                     <td>integer</td>                     <td>Z position of the node</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidnodessuspend.txt
+

docs/api/v2/controller/project/projects.rst

@@ -54,6 +54,12 @@ Output
     <tr><td>zoom</td>                    <td> </td>                     <td>integer</td>                     <td>Zoom of the drawing area</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projects.txt
+
 
 GET /v2/projects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -63,3 +69,9 @@ Response status codes
 **********************
 - **200**: List of projects
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projects.txt
+

docs/api/v2/controller/project/projectsload.rst

@@ -48,3 +48,9 @@ Output
     <tr><td>zoom</td>                    <td> </td>                     <td>integer</td>                     <td>Zoom of the drawing area</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsload.txt
+

docs/api/v2/controller/project/projectsprojectid.rst

@@ -16,6 +16,12 @@ Response status codes
 - **200**: Project information returned
 - **404**: The project doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectid.txt
+
 
 PUT /v2/projects/**{project_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -70,6 +76,12 @@ Output
     <tr><td>zoom</td>                    <td> </td>                     <td>integer</td>                     <td>Zoom of the drawing area</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_put_projectsprojectid.txt
+
 
 DELETE /v2/projects/**{project_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -81,6 +93,12 @@ Parameters
 
 Response status codes
 **********************
-- **404**: The project doesn't exist
 - **204**: Changes have been written on disk
+- **404**: The project doesn't exist
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt
 

docs/api/v2/controller/project/projectsprojectidclose.rst

@@ -13,8 +13,8 @@ Parameters
 
 Response status codes
 **********************
-- **404**: The project doesn't exist
 - **204**: The project has been closed
+- **404**: The project doesn't exist
 
 Output
 *******
@@ -39,3 +39,9 @@ Output
     <tr><td>zoom</td>                    <td> </td>                     <td>integer</td>                     <td>Zoom of the drawing area</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt
+

docs/api/v2/controller/project/projectsprojectidduplicate.rst

@@ -59,3 +59,9 @@ Output
     <tr><td>zoom</td>                    <td> </td>                     <td>integer</td>                     <td>Zoom of the drawing area</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidduplicate.txt
+

docs/api/v2/controller/project/projectsprojectidopen.rst

@@ -39,3 +39,9 @@ Output
     <tr><td>zoom</td>                    <td> </td>                     <td>integer</td>                     <td>Zoom of the drawing area</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidopen.txt
+

docs/api/v2/controller/server/settings.rst

@@ -11,6 +11,12 @@ Response status codes
 **********************
 - **200**: OK
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_settings.txt
+
 
 POST /v2/settings
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -20,3 +26,9 @@ Response status codes
 **********************
 - **201**: Writed
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_settings.txt
+

docs/api/v2/controller/server/shutdown.rst

@@ -12,3 +12,9 @@ Response status codes
 - **201**: Server is shutting down
 - **403**: Server shutdown refused
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_shutdown.txt
+

docs/api/v2/controller/server/version.rst

@@ -21,6 +21,12 @@ Output
     <tr><td>version</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Version number</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_version.txt
+
 
 POST /v2/version
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -51,3 +57,9 @@ Output
     <tr><td>version</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Version number</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_version.txt
+

docs/api/v2/controller/snapshot/projectsprojectidsnapshots.rst

@@ -37,6 +37,12 @@ Output
     <tr><td>snapshot_id</td>                    <td>&#10004;</td>                     <td>string</td>                     <td>Snapshot UUID</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidsnapshots.txt
+
 
 GET /v2/projects/**{project_id}**/snapshots
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -51,3 +57,9 @@ Response status codes
 - **200**: Snasphot list returned
 - **404**: The project doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidsnapshots.txt
+

docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotid.rst

@@ -9,11 +9,17 @@ Delete a snapshot from disk
 
 Parameters
 **********
-- **snapshot_id**: Snasphot UUID
 - **project_id**: Project UUID
+- **snapshot_id**: Snasphot UUID
 
 Response status codes
 **********************
-- **404**: The project or snapshot doesn't exist
 - **204**: Changes have been written on disk
+- **404**: The project or snapshot doesn't exist
+
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectidsnapshotssnapshotid.txt
 

docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst

@@ -9,8 +9,8 @@ Restore a snapshot from disk
 
 Parameters
 **********
-- **snapshot_id**: Snasphot UUID
 - **project_id**: Project UUID
+- **snapshot_id**: Snasphot UUID
 
 Response status codes
 **********************
@@ -40,3 +40,9 @@ Output
     <tr><td>zoom</td>                    <td> </td>                     <td>integer</td>                     <td>Zoom of the drawing area</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidsnapshotssnapshotidrestore.txt
+

docs/api/v2/controller/symbol/symbols.rst

@@ -11,3 +11,9 @@ Response status codes
 **********************
 - **200**: Symbols list returned
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_symbols.txt
+