From 7adb297fed6865a4e0bfb498d7e8d019c588c522 Mon Sep 17 00:00:00 2001 From: Boden R Date: Fri, 8 Sep 2017 14:30:36 -0600 Subject: [PATCH] doc for quota details extension This patch adds a blurb about the quota detail API extension to wrap up the doc aspect of this feature. Change-Id: I3de3a686d70d74e10d01880c1ec0f4dd5b047038 Closes-Bug: #1704914 --- doc/source/contributor/internals/quota.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/doc/source/contributor/internals/quota.rst b/doc/source/contributor/internals/quota.rst index 3450b20293c..b4e5d72fe32 100644 --- a/doc/source/contributor/internals/quota.rst +++ b/doc/source/contributor/internals/quota.rst @@ -55,7 +55,7 @@ High Level View There are two main components in the Neutron quota system: - * The Quota API extension; + * The Quota API extensions. * The Quota Engine. Both components rely on a quota driver. The neutron codebase currently defines @@ -76,6 +76,11 @@ Please note that the current behaviour when deleting a project quota is to reset quota limits for that project to configuration defaults. The API extension does not validate the project identifier with the identity service. +In addition, the Quota Detail API extension complements the Quota API extension +by allowing users (typically admins) the ability to retrieve details about +quotas per project. Quota details include the used/limit/reserved +count for the project's resources (networks, ports, etc.). + Performing quota enforcement is the responsibility of the Quota Engine. RESTful API controllers, before sending a request to the plugin, try to obtain a reservation from the quota engine for the resources specified in the client