Update docs

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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -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

@@ -47,6 +47,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}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -62,3 +68,9 @@ Response status codes
 - **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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -59,3 +65,9 @@ Output
     <tr><td>project_id</td>                    <td> </td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinks.txt
+

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

@@ -62,3 +62,9 @@ Response status codes
 - **204**: Link deleted
 - **400**: Invalid request
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectidlinkslinkid.txt
+

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

@@ -42,3 +42,9 @@ Output
     <tr><td>project_id</td>                    <td> </td>                     <td>string</td>                     <td>Project UUID</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt
+

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

@@ -17,3 +17,9 @@ Response status codes
 - **201**: Capture stopped
 - **400**: Invalid request
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt
+

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

@@ -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}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -133,3 +145,9 @@ Response status codes
 - **400**: Invalid request
 - **404**: Instance doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_delete_projectsprojectidnodesnodeid.txt
+

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

@@ -18,3 +18,9 @@ Response status codes
 - **400**: Invalid request
 - **404**: Instance doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsautoidlepc.txt
+

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

@@ -18,3 +18,9 @@ Response status codes
 - **400**: Invalid request
 - **404**: Instance doesn't exist
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projectsprojectidnodesnodeiddynamipsidlepcproposals.txt
+

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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -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

@@ -44,6 +44,12 @@ Output
     <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: opened, closed</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projects.txt
+
 
 GET /v2/projects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -53,3 +59,9 @@ Response status codes
 **********************
 - **200**: List of projects
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_get_projects.txt
+

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

@@ -43,3 +43,9 @@ Output
     <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: opened, closed</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}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -60,6 +66,12 @@ Output
     <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: opened, closed</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_put_projectsprojectid.txt
+
 
 DELETE /v2/projects/**{project_id}**
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -74,3 +86,9 @@ Response status codes
 - **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

@@ -34,3 +34,9 @@ Output
     <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: opened, closed</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt
+

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

@@ -49,3 +49,9 @@ Output
     <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: opened, closed</td>                     </tr>
     </table>
 
+Sample session
+***************
+
+
+.. literalinclude:: ../../../examples/controller_post_projectsprojectidduplicate.txt
+

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

@@ -34,3 +34,9 @@ Output
     <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: opened, closed</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

@@ -17,3 +17,9 @@ Response status codes
 - **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

@@ -35,3 +35,9 @@ Output
     <tr><td>status</td>                    <td> </td>                     <td>enum</td>                     <td>Possible values: opened, closed</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
+