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-26 19:57:53 +02:00
1 parent 68eca6c111
commit c96bd5f2a9
211 files changed
+999 -717
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/drawing/projectsprojectiddrawingsdrawingid.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Create a new drawing instance
Parameters
**********
- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -60,8 +60,8 @@ Delete a drawing instance
Parameters
**********
- **project_id**: Project UUID
- **drawing_id**: Drawing UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
+2 -2
View File
@@ -9,8 +9,8 @@ Update a link instance
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -52,8 +52,8 @@ Delete a link instance
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project 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
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project 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
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project 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
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeid.rst
+1 -1
View File
@@ -80,8 +80,8 @@ Delete a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project 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
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project 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
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidreload.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Reload a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidstart.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Start a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidstop.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stop a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/node/projectsprojectidnodesnodeidsuspend.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Suspend a node instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
docs/api/v2/controller/project/projectsprojectidduplicate.rst
+49
View File
@@ -0,0 +1,49 @@
/v2/projects/{project_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate a project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **201**: Project duplicate
- **403**: The server is not the local server
- **404**: The project doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </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> </td> <td>['string', 'null']</td> <td>Project UUID</td> </tr>
</table>
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>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidduplicate.txt
docs/api/v2/controller/snapshot.rst
+8
View File
@@ -0,0 +1,8 @@
Snapshot
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
snapshot/*
docs/api/v2/controller/snapshot/projectsprojectidsnapshots.rst
+65
View File
@@ -0,0 +1,65 @@
/v2/projects/{project_id}/snapshots
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/snapshots
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create snapshot of a project
Parameters
**********
- **project_id**: Project UUID
Response status codes
**********************
- **201**: Snasphot created
- **404**: The project doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td>&#10004;</td> <td></td> <td>Snapshot name</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>created_at</td> <td>&#10004;</td> <td>integer</td> <td>Date of the snapshot (UTC timestamp)</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Project name</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List snapshots of a project
Parameters
**********
- **project_id**: Project UUID
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
+25
View File
@@ -0,0 +1,25 @@
/v2/projects/{project_id}/snapshots/{snapshot_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
DELETE /v2/projects/**{project_id}**/snapshots/**{snapshot_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a snapshot from disk
Parameters
**********
- **snapshot_id**: Snasphot UUID
- **project_id**: Project UUID
Response status codes
**********************
- **404**: The project or snapshot doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidsnapshotssnapshotid.txt
docs/api/v2/controller/snapshot/projectsprojectidsnapshotssnapshotidrestore.rst
+38
View File
@@ -0,0 +1,38 @@
/v2/projects/{project_id}/snapshots/{snapshot_id}/restore
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/projects/**{project_id}**/snapshots/**{snapshot_id}**/restore
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Restore a snapshot from disk
Parameters
**********
- **snapshot_id**: Snasphot UUID
- **project_id**: Project UUID
Response status codes
**********************
- **201**: The snapshot has been restored
- **404**: The project or snapshot doesn't exist
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>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidsnapshotssnapshotidrestore.txt