From 422d58b1dcab22650a6c0a86d2c227e02eb7b57c Mon Sep 17 00:00:00 2001 From: Andrey Volkov Date: Wed, 24 May 2017 11:47:20 +0300 Subject: [PATCH] [placement] Add api-ref for DELETE resource provider This provides simple documentation of the path parameters when deleting a resource provider. Change-Id: I8cf3f1482450765d3e1daf83b6f595303d191a28 --- .../source/resource_provider.inc | 28 +++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/placement-api-ref/source/resource_provider.inc b/placement-api-ref/source/resource_provider.inc index 5b718d2e76..bc1dcbbd77 100644 --- a/placement-api-ref/source/resource_provider.inc +++ b/placement-api-ref/source/resource_provider.inc @@ -85,3 +85,31 @@ Response Example .. literalinclude:: update-resource_provider.json :language: javascript + +Delete resource provider +======================== + +.. rest_method:: DELETE /resource_providers/{uuid} + +Delete the resource provider identified by `{uuid}`. +This will also disassociate aggregates and delete inventories. + +Normal Response Codes: 204 + +Error response codes: itemNotFound(404), conflict(409) + +A `409 Conflict` response code will be returned if there exist +allocations records for any of the inventories that would be deleted +as a result of removing the resource provider. + +Request +------- + +.. rest_parameters:: parameters.yaml + + - uuid: resource_provider_uuid_path + +Response +-------- + +No body content is returned on a successful DELETE.