senlin/api-ref/source/receivers.inc
tengqm a59311faca api-ref: OpenStack-Request-Id and location
We are returning the header X-OpenStack-Request-Id when returning a
meaningful result from the server. This has to be documented.
This patch also fixes the location header parameter that could be
returned which should be called 'Location'.

Change-Id: Idd0c74c249e5f21b6af954877b544ca1f005e203
2016-08-25 04:45:25 -04:00

243 lines
4.1 KiB
PHP

=====================
Receivers (receivers)
=====================
Lists all receivers and creates, shows information for, and deletes a receiver.
List receivers
==============
.. rest_method:: GET /v1/receivers
Lists all receivers.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 503
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- limit: limit
- marker: marker
- sort: sort
- global_project: global_project
- name: name_query
- type: receiver_type_query
- user: user_query
- cluster_id: cluster_identity_query
- action: receiver_action_query
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
- receivers: receivers
- action: receiver_action
- actor: receiver_actor
- channel: receiver_channel
- cluster_id: cluster_id
- created_at: created_at
- domain: domain
- id: receiver_id
- name: name
- params: receiver_params
- project: project
- type: receiver_type
- updated_at: updated_at
- user: user
Response Example
----------------
.. literalinclude:: samples/receivers-list-response.json
:language: javascript
Create receiver
===============
.. rest_method:: POST /v1/receivers
Creates a receiver.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 201
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 500
- 503
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- receiver: receiver
- name: name
- cluster_id: receiver_cluster_identity
- type: receiver_type_req
- action: receiver_action
- actor: receiver_actor
- params: receiver_params_req
Request Example
---------------
.. literalinclude:: samples/receiver-create-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
- receiver: receiver
- action: receiver_action
- actor: receiver_actor
- channel: receiver_channel
- cluster_id: cluster_id
- created_at: created_at
- domain: domain
- id: receiver_id
- name: name
- params: receiver_params
- project: project
- type: receiver_type
- updated_at: updated_at
- user: user
Response Example
----------------
.. literalinclude:: samples/receiver-create-response.json
:language: javascript
Show receiver details
=====================
.. rest_method:: GET /v1/receivers/{receiver_id}
Shows details for a receiver.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 503
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- receiver_id: receiver_id_url
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
- receiver: receiver
- action: receiver_action
- actor: receiver_actor
- channel: receiver_channel
- cluster_id: cluster_id
- created_at: created_at
- domain: domain
- id: receiver_id
- name: name
- params: receiver_params
- project: project
- type: receiver_type
- updated_at: updated_at
- user: user
Response Example
----------------
.. literalinclude:: samples/receiver-show-response.json
:language: javascript
Delete receiver
===============
.. rest_method:: DELETE /v1/receivers/{receiver_id}
Deletes a receiver.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 204
.. rest_status_code:: error status.yaml
- 400
- 401
- 403
- 404
- 503
Request Parameters
------------------
This operation does not accept a request body.
.. rest_parameters:: parameters.yaml
- OpenStack-API-Version: microversion
- receiver_id: receiver_id_url
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- X-OpenStack-Request-Id: request_id
This operation does not return a response body.