Import RST files for documentation

This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.

Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
This commit is contained in:
Sean Dague
2016-04-12 09:03:46 -04:00
parent f1fa7eb15a
commit d4e2771440
58 changed files with 8201 additions and 3 deletions
+68
View File
@@ -0,0 +1,68 @@
.. -*- rst -*-
=======================================================
Servers - list actions (servers, os-instance-actions)
=======================================================
All users can list available actions for a server.
All users can show details for a server action; however, only
administrators can view server events in server action details.
List Actions For Server
=======================
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-instance-actions
Lists actions for a server.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
Response
^^^^^^^^
**Example List Actions For Server: JSON request**
.. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-actions-list-resp.json
:language: javascript
Show Server Action Details
==========================
.. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-instance-actions/{request_id}
Shows details for a server action.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
^^^^^^^
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- server_id: server_id
- request_id: request_id
Response
^^^^^^^^
**Example Show Server Action Details: JSON request**
.. literalinclude:: ../../doc/api_samples/os-instance-actions/instance-action-show-resp.json
:language: javascript