mirror of
https://github.com/GNS3/gns3-server.git
synced 2026-11-04 14:31:13 +02:00
Update API documentation
This commit is contained in:
1 parent
21a7a68875
commit
e6d2bd4424
360 files changed
+17598
-896
No files matched your search
@@ -9,8 +9,8 @@ Get an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -43,6 +43,12 @@ Output
|
||||
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_get_projectsprojectidiounodesnodeid.txt
|
||||
|
||||
|
||||
PUT /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -50,8 +56,8 @@ Update an IOU instance
|
||||
|
||||
Parameters
|
||||
**********
|
||||
- **node_id**: Node UUID
|
||||
- **project_id**: Project UUID
|
||||
- **node_id**: Node UUID
|
||||
|
||||
Response status codes
|
||||
**********************
|
||||
@@ -110,6 +116,12 @@ Output
|
||||
<tr><td>use_default_iou_values</td> <td> </td> <td>['boolean', 'null']</td> <td>Use default IOU values</td> </tr>
|
||||
</table>
|
||||
|
||||
Sample session
|
||||
***************
|
||||
|
||||
|
||||
.. literalinclude:: ../../../examples/compute_put_projectsprojectidiounodesnodeid.txt
|
||||
|
||||
|
||||
DELETE /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
@@ -117,12 +129,18 @@ Delete an IOU 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_projectsprojectidiounodesnodeid.txt
|
||||
|
||||
Reference in new issue
Block a user