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

This commit is contained in:
grossmj committed 2018-11-20 13:04:27 +07:00
1 parent e5950674f8
commit ff5ba3742e
343 files changed
+12431 -11199

No files matched your search

@@ -13,8 +13,8 @@ Parameters
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
- **400**: Invalid request
- **409**: Conflict
Input
@@ -14,9 +14,9 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
PUT /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**
@@ -9,15 +9,15 @@ Add a NIO to a Docker container
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 (always 0)
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO created
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -29,19 +29,19 @@ Sample session
PUT /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/nio
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update a NIO from a Docker instance
Update a NIO on a Docker instance
Parameters
**********
- **adapter_number**: Network adapter where the nio is located
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port from where the nio should be updated
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be updated (always 0)
Response status codes
**********************
- **400**: Invalid request
- **201**: NIO updated
- **400**: Invalid request
- **404**: Instance doesn't exist
Sample session
@@ -57,16 +57,16 @@ Remove a NIO from a Docker container
Parameters
**********
- **adapter_number**: Adapter where the nio should be added
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **204**: NIO deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: NIO deleted
Sample session
***************
@@ -9,10 +9,10 @@ Start a packet capture on a Docker container instance
Parameters
**********
- **adapter_number**: Adapter to start a packet capture
- **project_id**: Project UUID
- **node_id**: Node UUID
- **port_number**: Port on the adapter
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
@@ -9,16 +9,16 @@ Stop a packet capture on a Docker container 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
- **409**: Container not started
Sample session
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance paused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance paused
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance restarted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance restarted
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance started
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance started
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance stopped
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance stopped
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance suspended
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance suspended
@@ -14,7 +14,7 @@ Parameters
Response status codes
**********************
- **204**: Instance unpaused
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance unpaused