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

Refresh documentation

Browse Source
This commit is contained in:
grossmj committed 2019-03-30 15:56:26 +07:00
1 parent 5045c6cfbf
commit 22854f1baa
438 files changed
+3043 -22117
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/project/projectsprojectidexport.rst
-18
View File
@@ -1,18 +0,0 @@
/v2/compute/projects/{project_id}/export
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/export
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Export a project as a portable archive
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: File returned
- **404**: The project doesn't exist
docs/api/v2/compute/project/projectsprojectidimport.rst
-45
View File
@@ -1,45 +0,0 @@
/v2/compute/projects/{project_id}/import
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/compute/projects/**{project_id}**/import
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Import a project from a portable archive
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: Project imported
- **403**: Forbidden to import project
Output
*******
.. raw:: html
<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 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>drawing_grid_size</td> <td> </td> <td>integer</td> <td>Grid size for the drawing area for drawings</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 for nodes</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>
<tr><td>scene_height</td> <td> </td> <td>integer</td> <td>Height of the drawing area</td> </tr>
<tr><td>scene_width</td> <td> </td> <td>integer</td> <td>Width of the drawing area</td> </tr>
<tr><td>show_grid</td> <td> </td> <td>boolean</td> <td>Show the grid on the drawing area</td> </tr>
<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>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/compute/project/projectsprojectidstreampath.rst
-19
View File
@@ -1,19 +0,0 @@
/v2/compute/projects/{project_id}/stream/{path:.+}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/stream/**{path:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream a file from a project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist