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

Update API documentation. Fixes #1253.

Browse Source
This commit is contained in:
grossmj committed 2018-01-08 11:57:07 +07:00
1 parent e8353e68bb
commit ffe21f6b73
324 files changed
+1168 -14199
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs/api/v2/compute/nat/projectsprojectidnatnodes.rst
+1 -7
View File
@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **201**: Instance created
- **400**: Invalid request
- **201**: Instance created
- **409**: Conflict
Input
@@ -43,9 +43,3 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_post_projectsprojectidnatnodes.txt
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeid.rst
+4 -22
View File
@@ -9,8 +9,8 @@ Get a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -31,12 +31,6 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_get_projectsprojectidnatnodesnodeid.txt
PUT /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -44,8 +38,8 @@ Update a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
@@ -80,12 +74,6 @@ Output
<tr><td>status</td> <td> </td> <td>enum</td> <td>Possible values: started, stopped, suspended</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/compute_put_projectsprojectidnatnodesnodeid.txt
DELETE /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -93,18 +81,12 @@ Delete a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidnatnodesnodeid.txt
- **204**: Instance deleted
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+21 -15
View File
@@ -9,22 +9,34 @@ Add a NIO to a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **adapter_number**: Adapter on the nat (always 0)
Response status codes
**********************
- **201**: NIO created
- **400**: Invalid request
- **201**: NIO created
- **404**: Instance doesn't exist
Sample session
***************
PUT /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a NAT instance
.. literalinclude:: ../../../examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **port_number**: Port from where the nio should be updated
- **adapter_number**: Network adapter where the nio is located
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **404**: Instance doesn't exist
DELETE /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
@@ -33,20 +45,14 @@ Remove a NIO from a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **adapter_number**: Adapter on the nat (always 0)
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdnio.txt
- **204**: NIO deleted
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+2 -2
View File
@@ -9,10 +9,10 @@ Start a packet capture on a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **adapter_number**: Adapter on the nat (always 0)
Response status codes
**********************
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+3 -3
View File
@@ -9,14 +9,14 @@ Stop a packet capture on a nat instance
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter on the nat (always 0)
- **project_id**: Project UUID
- **port_number**: Port on the nat
- **adapter_number**: Adapter on the nat (always 0)
Response status codes
**********************
- **204**: Capture stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Capture stopped
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidstart.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Start a nat
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidstop.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Stop a nat
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidsuspend.rst
+2 -2
View File
@@ -9,12 +9,12 @@ Suspend a nat
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **project_id**: Project UUID
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended