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

Update API documentation

Browse Source
This commit is contained in:
Bernhard Ehlers committed 2018-01-08 09:26:44 +01:00
1 parent 21a7a68875
commit e6d2bd4424
360 files changed
+17598 -896
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/controller/link/projectsprojectidlinks.rst
+13 -1
View File
@@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -26,8 +32,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Link created
- **400**: Invalid request
Input
*******
@@ -63,3 +69,9 @@ Output
<tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinks.txt
docs/api/v2/controller/link/projectsprojectidlinkslinkid.rst
+55 -4
View File
@@ -3,19 +3,58 @@
.. contents::
GET /v2/projects/**{project_id}**/links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a link instance
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
- **200**: Link found
- **400**: Invalid request
- **404**: Link doesn't exist
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>capture_file_name</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
<tr><td>capture_file_path</td> <td> </td> <td>['string', 'null']</td> <td>Read only property. The full path of the capture file if capture is running</td> </tr>
<tr><td>capturing</td> <td> </td> <td>boolean</td> <td>Read only property. True if a capture running on the link</td> </tr>
<tr><td>filters</td> <td> </td> <td>object</td> <td>Packet filter. This allow to simulate latency and errors</td> </tr>
<tr><td>link_id</td> <td> </td> <td>string</td> <td>Link UUID</td> </tr>
<tr><td>link_type</td> <td> </td> <td>enum</td> <td>Possible values: ethernet, serial</td> </tr>
<tr><td>nodes</td> <td> </td> <td>array</td> <td>List of the VMS</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinkslinkid.txt
PUT /v2/projects/**{project_id}**/links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a link instance
Parameters
**********
- **link_id**: Link UUID
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Link updated
- **400**: Invalid request
Input
*******
@@ -51,6 +90,12 @@ Output
<tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_projectsprojectidlinkslinkid.txt
DELETE /v2/projects/**{project_id}**/links/**{link_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -58,11 +103,17 @@ Delete a link instance
Parameters
**********
- **link_id**: Link UUID
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
- **400**: Invalid request
- **204**: Link deleted
- **400**: Invalid request
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidlinkslinkid.txt
docs/api/v2/controller/link/projectsprojectidlinkslinkidavailablefilters.rst
+25
View File
@@ -0,0 +1,25 @@
/v2/projects/{project_id}/links/{link_id}/available_filters
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/projects/**{project_id}**/links/**{link_id}**/available_filters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Return the list of filters available for this link
Parameters
**********
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
- **200**: List of filters
- **400**: Invalid request
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinkslinkidavailablefilters.txt
docs/api/v2/controller/link/projectsprojectidlinkslinkidpcap.rst
+1 -1
View File
@@ -9,8 +9,8 @@ Stream 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
+8 -2
View File
@@ -9,13 +9,13 @@ 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
**********************
- **400**: Invalid request
- **201**: Capture started
- **400**: Invalid request
Input
*******
@@ -44,3 +44,9 @@ Output
<tr><td>suspend</td> <td> </td> <td>boolean</td> <td>Suspend the link</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt
docs/api/v2/controller/link/projectsprojectidlinkslinkidstopcapture.rst
+8 -2
View File
@@ -9,11 +9,17 @@ Stop capture on a link instance
Parameters
**********
- **link_id**: Link UUID
- **project_id**: Project UUID
- **link_id**: Link UUID
Response status codes
**********************
- **400**: Invalid request
- **201**: Capture stopped
- **400**: Invalid request
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt