[placement] Add api-ref for DELETE RP inventory

This provides simple documentation of the path parameters when deleting
a single inventory record for a resource provider.

Change-Id: Ie7eeb426744bccf5e976ed304fa6f0a58b38ac01
This commit is contained in:
Andrey Volkov 2017-04-10 13:13:25 +03:00
parent f31c79f961
commit 5cd44bf2d1

View File

@ -93,4 +93,36 @@ Response Example
----------------
.. literalinclude:: update-inventory.json
:language: javascript
:language: javascript
Delete resource provider inventory
==================================
Delete the inventory record of the `{resource_class}` for
the resource provider identified by `{uuid}`.
See `Troubleshooting`_ section in ``Delete resource provider
inventories`` for a description. In addition, the request returns
HTTP 409 when there are allocations for the specified resource
provider and resource class.
.. _Troubleshooting: ?expanded=delete-resource-provider-inventories-detail#delete-resource-provider-inventories
.. rest_method:: DELETE /resource_providers/{uuid}/inventories/{resource_class}
Normal Response Codes: 204
Error response codes: itemNotFound(404), conflict(409)
Request
-------
.. rest_parameters:: parameters.yaml
- uuid: resource_provider_uuid_path
- resource_class: resource_class_path
Response
--------
No body content is returned on a successful DELETE.