Update API documentation for appliance endpoints. Ref https://github.com/GNS3/gns3-gui/issues/2630

2025-06-23 09:15:34 +00:00 · 2018-11-20 13:04:27 +07:00
parent e5950674f8
commit ff5ba3742e
343 changed files with 12431 additions and 11199 deletions
--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodes.rst
@ -13,8 +13,8 @@ Parameters

 Response status codes
 **********************
- **400**: Invalid request
 - **201**: Instance created
+- **400**: Invalid request
 - **409**: Conflict

 Input
--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeid.rst
@ -193,7 +193,7 @@ Parameters

 Response status codes
 **********************
+- **204**: Instance deleted
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: Instance deleted

--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdnio.rst
@ -9,33 +9,33 @@ Add a NIO to a Dynamips VM instance

 Parameters
 **********
- **adapter_number**: Adapter where the nio should be added
 - **project_id**: Project UUID
 - **node_id**: Node UUID
+- **adapter_number**: Adapter where the nio should be added
 - **port_number**: Port on the adapter

 Response status codes
 **********************
- **400**: Invalid request
 - **201**: NIO created
+- **400**: Invalid request
 - **404**: Instance doesn't exist


 PUT /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Update a NIO from a Dynamips instance
+Update a NIO on a Dynamips instance

 Parameters
 **********
- **adapter_number**: Network adapter where the nio is located
 - **project_id**: Project UUID
 - **node_id**: Node UUID
+- **adapter_number**: Network adapter where the nio is located
 - **port_number**: Port from where the nio should be updated

 Response status codes
 **********************
- **400**: Invalid request
 - **201**: NIO updated
+- **400**: Invalid request
 - **404**: Instance doesn't exist


@ -45,14 +45,14 @@ Remove a NIO from a Dynamips VM instance

 Parameters
 **********
- **adapter_number**: Adapter from where the nio should be removed
 - **project_id**: Project UUID
 - **node_id**: Node UUID
+- **adapter_number**: Adapter from where the nio should be removed
 - **port_number**: Port on the adapter

 Response status codes
 **********************
+- **204**: NIO deleted
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: NIO deleted

--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.rst
@ -9,9 +9,9 @@ Start a packet capture on a Dynamips VM instance

 Parameters
 **********
- **adapter_number**: Adapter to start a packet capture
 - **project_id**: Project UUID
 - **node_id**: Node UUID
+- **adapter_number**: Adapter to start a packet capture
 - **port_number**: Port on the adapter

 Response status codes
--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.rst
@ -9,14 +9,14 @@ Stop a packet capture on a Dynamips VM instance

 Parameters
 **********
- **adapter_number**: Adapter to stop a packet capture
 - **project_id**: Project UUID
 - **node_id**: Node UUID
+- **adapter_number**: Adapter to stop a packet capture
 - **port_number**: Port on the adapter (always 0)

 Response status codes
 **********************
+- **204**: Capture stopped
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: Capture stopped

--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidreload.rst
@ -14,7 +14,7 @@ Parameters

 Response status codes
 **********************
+- **204**: Instance reloaded
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: Instance reloaded

--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidresume.rst
@ -14,7 +14,7 @@ Parameters

 Response status codes
 **********************
+- **204**: Instance resumed
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: Instance resumed

--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstart.rst
@ -14,7 +14,7 @@ Parameters

 Response status codes
 **********************
+- **204**: Instance started
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: Instance started

--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidstop.rst
@ -14,7 +14,7 @@ Parameters

 Response status codes
 **********************
+- **204**: Instance stopped
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: Instance stopped

--- a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst
+++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidsuspend.rst
@ -14,7 +14,7 @@ Parameters

 Response status codes
 **********************
+- **204**: Instance suspended
 - **400**: Invalid request
 - **404**: Instance doesn't exist
- **204**: Instance suspended