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

+1
View File
@@ -37,6 +37,7 @@ Output
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>last_error</td> <td> </td> <td>['string', 'null']</td> <td>Last error on the compute</td> </tr>
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
+4 -2
View File
@@ -5,7 +5,7 @@
PUT /v2/computes/**{compute_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get a compute server information
Update a compute server
Response status codes
**********************
@@ -39,6 +39,7 @@ Output
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>last_error</td> <td> </td> <td>['string', 'null']</td> <td>Last error on the compute</td> </tr>
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
@@ -66,6 +67,7 @@ Output
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>Whether the controller is connected to the compute server or not</td> </tr>
<tr><td>cpu_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>CPU usage of the compute. Read only</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>last_error</td> <td> </td> <td>['string', 'null']</td> <td>Last error on the compute</td> </tr>
<tr><td>memory_usage_percent</td> <td> </td> <td>['number', 'null']</td> <td>RAM usage of the compute. Read only</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Server name</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
@@ -84,7 +86,7 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted