From 1753195c75ebc7380bccc8b39c8a16940fa66658 Mon Sep 17 00:00:00 2001
From: jichenjc <jichenjc@cn.ibm.com>
Date: Wed, 18 Oct 2017 22:34:19 +0800
Subject: [PATCH] [placement]Enhance doc for placement allocation list

add a note about when the non-existing consumer id input result

Change-Id: I2a19d8fe8dda5754112361be5ceac8a0dc747ae9
---
 placement-api-ref/source/allocations.inc | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/placement-api-ref/source/allocations.inc b/placement-api-ref/source/allocations.inc
index 8e3a0f9169b1..ddfb28985d99 100644
--- a/placement-api-ref/source/allocations.inc
+++ b/placement-api-ref/source/allocations.inc
@@ -58,6 +58,10 @@ List allocations
 List all allocation records for the consumer identified by
 `{consumer_uuid}` on all the resource providers it is consuming.
 
+.. note:: When listing allocations for a consumer uuid that has no
+          allocations a dict with an empty value is returned
+          ``{"allocations": {}}``.
+
 .. rest_method:: GET /allocations/{consumer_uuid}
 
 Normal Response Codes: 200