NgTech-LTD/gns3-server
2
0 Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2026-11-03 05:51:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update API documentation

Browse Source
This commit is contained in:
Bernhard Ehlers committed 2018-06-07 10:26:06 +02:00
1 parent 62f87de23a
commit 60a3ab87dc
226 files changed
+2983 -840
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/project/projects.rst
+6
View File
@@ -19,6 +19,7 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>auto_close</td> <td> </td> <td>boolean</td> <td>Project auto close</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td> </td> <td>['string', 'null']</td> <td>Project UUID</td> </tr>
@@ -28,6 +29,8 @@ Input
<tr><td>show_interface_labels</td> <td> </td> <td>boolean</td> <td>Show interface labels on the drawing area</td> </tr>
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
@@ -41,6 +44,7 @@ Output
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
@@ -51,6 +55,8 @@ Output
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
docs/api/v2/controller/project/projectsload.rst
+3
View File
@@ -35,6 +35,7 @@ Output
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
@@ -45,6 +46,8 @@ Output
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
docs/api/v2/controller/project/projectsprojectid.rst
+6
View File
@@ -42,6 +42,7 @@ Input
<tr><td>auto_close</td> <td> </td> <td>boolean</td> <td>Project auto close when client cut off the notifications feed</td> </tr>
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Path of the project on the server (work only with --local)</td> </tr>
<tr><td>scene_height</td> <td> </td> <td>integer</td> <td>Height of the drawing area</td> </tr>
@@ -50,6 +51,8 @@ Input
<tr><td>show_interface_labels</td> <td> </td> <td>boolean</td> <td>Show interface labels on the drawing area</td> </tr>
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
@@ -63,6 +66,7 @@ Output
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
@@ -73,6 +77,8 @@ Output
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
docs/api/v2/controller/project/projectsprojectidclose.rst
+3
View File
@@ -26,6 +26,7 @@ Output
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
@@ -36,6 +37,8 @@ Output
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
docs/api/v2/controller/project/projectsprojectidduplicate.rst
+6
View File
@@ -24,6 +24,7 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>auto_close</td> <td> </td> <td>boolean</td> <td>Project auto close</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td> </td> <td>['string', 'null']</td> <td>Project UUID</td> </tr>
@@ -33,6 +34,8 @@ Input
<tr><td>show_interface_labels</td> <td> </td> <td>boolean</td> <td>Show interface labels on the drawing area</td> </tr>
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
@@ -46,6 +49,7 @@ Output
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
@@ -56,6 +60,8 @@ Output
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
docs/api/v2/controller/project/projectsprojectidimport.rst
+3
View File
@@ -26,6 +26,7 @@ Output
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
@@ -36,6 +37,8 @@ Output
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>
docs/api/v2/controller/project/projectsprojectidopen.rst
+3
View File
@@ -26,6 +26,7 @@ Output
<tr><td>auto_open</td> <td> </td> <td>boolean</td> <td>Project open when GNS3 start</td> </tr>
<tr><td>auto_start</td> <td> </td> <td>boolean</td> <td>Project start when opened</td> </tr>
<tr><td>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</td> </tr>
<tr><td>grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area</td> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
@@ -36,6 +37,8 @@ Output
<tr><td>show_layers</td> <td> </td> <td>boolean</td> <td>Show layers on the drawing area</td> </tr>
<tr><td>snap_to_grid</td> <td> </td> <td>boolean</td> <td>Snap to grid on the drawing area</td> </tr>
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
<tr><td>supplier</td> <td> </td> <td>['object', 'null']</td> <td>Supplier of the project</td> </tr>
<tr><td>variables</td> <td> </td> <td>['array', 'null']</td> <td>Variables required to run the project</td> </tr>
<tr><td>zoom</td> <td> </td> <td>integer</td> <td>Zoom of the drawing area</td> </tr>
</table>