Update API documentation

This commit is contained in:
Bernhard Ehlers committed 2018-01-08 09:26:44 +01:00
1 parent 21a7a68875
commit e6d2bd4424
360 files changed
+17598 -896

No files matched your search

@@ -0,0 +1,27 @@
/v2/computes/endpoint/{compute_id}/{emulator}/{action:.+}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/computes/endpoint/**{compute_id}**/**{emulator}**/**{action:.+}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Returns the endpoint for particular `compute` to specific action. WARNING: This is experimental feature and may change anytime. Please don't rely on this endpoint.
Parameters
**********
- **compute_id**: Compute UUID
Response status codes
**********************
- **200**: OK
- **404**: Instance doesn't exist
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>endpoint</td> <td> </td> <td>string</td> <td>URL to endpoint on specific compute and to particular action</td> </tr>
</table>
+1 -1
View File
@@ -84,7 +84,7 @@ Parameters
Response status codes
**********************
- **204**: Instance deleted
- **400**: Invalid request
- **404**: Instance doesn't exist
- **204**: Instance deleted
@@ -0,0 +1,17 @@
/v2/computes/{compute_id}/auto_idlepc
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/computes/**{compute_id}**/auto_idlepc
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Compute IDLE PC value
Parameters
**********
- **compute_id**: Compute UUID
Response status codes
**********************
- **200**: Idle PC computed