ExternalVendorCode/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2025-06-23 17:17:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update API documentation

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

26
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeid.rst
View File

@ -9,8 +9,8 @@ Get a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -31,6 +31,12 @@ 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}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -38,8 +44,8 @@ Update a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
@ -74,6 +80,12 @@ 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}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@ -81,12 +93,18 @@ Delete a nat instance
Parameters
**********
- **node_id**: Node UUID
- **project_id**: Project UUID
- **node_id**: Node UUID
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
Sample session
***************
.. literalinclude:: ../../../examples/compute_delete_projectsprojectidnatnodesnodeid.txt