mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-03 05:51:15 +02:00
Update the documentation
This commit is contained in:
319 files changed
+921
-5755
No files matched your search
@@ -15,12 +15,6 @@ Response status codes
|
||||
**********************
|
||||
- **200**: List of links returned
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_get_projectsprojectidlinks.txt
|
||||
|
||||
|
||||
POST /v2/projects/**{project_id}**/links
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -32,8 +26,8 @@ Parameters
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
- **400**: Invalid request
|
||||
- **201**: Link created
|
||||
- **400**: Invalid request
|
||||
|
||||
Input
|
||||
*******
|
||||
@@ -65,9 +59,3 @@ Output
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinks.txt
|
||||
|
||||
@@ -9,13 +9,13 @@ 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
|
||||
*******
|
||||
@@ -54,17 +54,11 @@ 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
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_delete_projectsprojectidlinkslinkid.txt
|
||||
- **400**: Invalid request
|
||||
|
||||
@@ -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
|
||||
**********************
|
||||
|
||||
@@ -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
|
||||
*******
|
||||
@@ -24,7 +24,7 @@ Input
|
||||
<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</td> <td>Read only property. The name of the capture file if capture is running</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC</td> </tr>
|
||||
<tr><td>data_link_type</td> <td> </td> <td>enum</td> <td>Possible values: DLT_ATM_RFC1483, DLT_EN10MB, DLT_FRELAY, DLT_C_HDLC, DLT_PPP_SERIAL</td> </tr>
|
||||
</table>
|
||||
|
||||
Output
|
||||
@@ -42,9 +42,3 @@ Output
|
||||
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project UUID</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstartcapture.txt
|
||||
|
||||
@@ -9,17 +9,11 @@ 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
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/controller_post_projectsprojectidlinkslinkidstopcapture.txt
|
||||
- **400**: Invalid request
|
||||
|
||||
Reference in new issue
Block a user