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 documentation

Browse Source
This commit is contained in:
Julien Duponchelle committed 2016-07-22 13:54:57 +02:00
1 parent ce557ecd23
commit 19b035d7e4
205 files changed
+1043 -945
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Update a link instance
Parameters
**********
- **link_id**: Link UUID
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
@@ -52,8 +52,8 @@ Delete a link instance
Parameters
**********
- **link_id**: Link UUID
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Steam 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
+1 -1
View File
@@ -9,8 +9,8 @@ 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
**********************
docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop capture on a link instance
Parameters
**********
- **link_id**: Link UUID
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+1 -1
View File
@@ -80,8 +80,8 @@ Delete a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsautoidlepc.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Compute the IDLE PC for a Dynamips node
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeiddynamipsidlepcproposals.rst
+1 -1
View File
@@ -9,8 +9,8 @@ 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
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a node instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
docs/api/v2/controller/project/projectsprojectidexport.rst
+18
View File
@@ -0,0 +1,18 @@
/v2/projects/{project_id}/export
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/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/controller/project/projectsprojectidfilespath.rst
+34
View File
@@ -0,0 +1,34 @@
/v2/projects/{project_id}/files/{path:.+}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/files/**{path:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a file from a project. Beware you have warranty to be able to access only to file global to the project (for example README.txt)
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist
POST /v2/projects/**{project_id}**/files/**{path:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write a file to a project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The path doesn't exist
docs/api/v2/controller/project/projectsprojectidimport.rst
+31
View File
@@ -0,0 +1,31 @@
/v2/projects/{project_id}/import
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/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>filename</td> <td> </td> <td>['string', 'null']</td> <td>Project filename</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>status</td> <td> </td> <td>enum</td> <td>Possible values: opened, closed</td> </tr>
</table>