summaryrefslogtreecommitdiff
path: root/placement-api-ref
diff options
context:
space:
mode:
authorAndrey Volkov <avolkov@mirantis.com>2017-04-10 13:13:25 +0300
committerAndrey Volkov <avolkov@mirantis.com>2017-05-29 09:18:32 +0300
commit5cd44bf2d1aa117191a33a2cc03c7e2a5e1e5bce (patch)
tree879e1f5c507eb90c9aa40a2cab11fd97deb13b8d /placement-api-ref
parentf31c79f961507a282bb8362168f59f462b8fa7a6 (diff)
downloadnova-5cd44bf2d1aa117191a33a2cc03c7e2a5e1e5bce.tar.gz
[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
Diffstat (limited to 'placement-api-ref')
-rw-r--r--placement-api-ref/source/inventory.inc34
1 files changed, 33 insertions, 1 deletions
diff --git a/placement-api-ref/source/inventory.inc b/placement-api-ref/source/inventory.inc
index aaf5f4cca1..c9b024eeb0 100644
--- a/placement-api-ref/source/inventory.inc
+++ b/placement-api-ref/source/inventory.inc
@@ -93,4 +93,36 @@ Response Example
----------------
.. literalinclude:: update-inventory.json
- :language: javascript \ No newline at end of file
+ :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.