ac4cc65cb5
Contains .inc files which have all the contents of the .rst files but are grouped together for easier editing. Contains parameters.yaml, which has all parameters in one file. Contains request and response samples (JSON and XML) that are pointed to from the .inc files. Change-Id: I42d5451300f95774a3ec4df66bc95cb36795844d
77 lines
930 B
ReStructuredText
77 lines
930 B
ReStructuredText
.. -*- rst -*-
|
|
|
|
=======
|
|
Actions
|
|
=======
|
|
|
|
Lists all actions and shows details for an action.
|
|
|
|
|
|
Show action details
|
|
===================
|
|
|
|
.. rest_method:: GET /v1/actions/{action_id}
|
|
|
|
Shows details for an action.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- action_id: action_id
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/action-show-response.json
|
|
:language: javascript
|
|
|
|
|
|
|
|
|
|
List actions
|
|
============
|
|
|
|
.. rest_method:: GET /v1/actions
|
|
|
|
Lists all actions.
|
|
|
|
|
|
Normal response codes: 200
|
|
Error response codes:
|
|
|
|
|
|
Request
|
|
-------
|
|
|
|
.. rest_parameters:: parameters.yaml
|
|
|
|
- limit: limit
|
|
- marker: marker
|
|
- sort: sort
|
|
- global_project: global_project
|
|
- name: name
|
|
- target: target
|
|
- action: action
|
|
|
|
|
|
|
|
|
|
Response Example
|
|
----------------
|
|
|
|
.. literalinclude:: ../samples/actions-list-response.json
|
|
:language: javascript
|
|
|
|
|
|
|