cinder/api-ref/source/v3/worker-cleanup.inc
whoami-rajat 609412fcd2 Improve/Clean api-ref parameters
The parameters with name like example_1, example_2 ... etc. cause
confusion while updating the api-ref docs like the examples below:

https://review.openstack.org/#/c/609639/
https://review.openstack.org/#/c/609611/

This patch does the following changes :
1) Replace numbering in the parameter with relevant names
2) Clean up unused parameters

Change-Id: I35b343bf068281d729576e5ecc209bda60c28680
2018-11-05 10:47:14 +05:30

63 lines
1.1 KiB
ReStructuredText

.. -*- rst -*-
Workers (workers)
=================
Cleanup services
~~~~~~~~~~~~~~~~
.. rest_method:: POST v3/{project_id}/workers/cleanup
Request cleanup of services with optional filtering. This API is only
available with microversion 3.24 or later.
Response codes
--------------
.. rest_status_code:: success ../status.yaml
- 202
Request
-------
.. rest_parameters:: parameters.yaml
- project_id: project_id_path
- cluster_name: cluster_mutex
- service_id: service_id
- host: host_service
- binary: binary_required
- is-up: is_up
- disabled: disabled
- resource-id: resource_id
- resource-type: resource_type
Request Example
---------------
.. literalinclude:: ./samples/worker-cleanup-request.json
:language: javascript
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- host: host_service
- binary: binary_required
- id: service_id
- cluster_name: cluster_mutex
Response Example
----------------
.. literalinclude:: ./samples/worker-cleanup-response.json
:language: javascript