From bc7b9fbbbc13d0a24f9330d016ada739f78b2e1c Mon Sep 17 00:00:00 2001
From: liyi <liyi8611@gmail.com>
Date: Fri, 14 Jul 2017 09:39:06 +0800
Subject: [PATCH] Update cluster policies API doc

Change-Id: I36c52109374e6708ee013715d57612a55cf06e3d
---
 api-ref/source/cluster_policies.inc | 2 ++
 api-ref/source/clusters.inc         | 2 ++
 api-ref/source/parameters.yaml      | 7 +++++--
 api-ref/source/policies.inc         | 3 +++
 4 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/api-ref/source/cluster_policies.inc b/api-ref/source/cluster_policies.inc
index 282fb7f02..9ec738138 100644
--- a/api-ref/source/cluster_policies.inc
+++ b/api-ref/source/cluster_policies.inc
@@ -34,6 +34,8 @@ Request Parameters
   - OpenStack-API-Version: microversion
   - cluster_id: cluster_id_url
   - enabled: enabled_query
+  - policy_name: name_query
+  - policy_type: type_query
   - sort: sort
 
 Response Parameters
diff --git a/api-ref/source/clusters.inc b/api-ref/source/clusters.inc
index 0fa4da01b..4aa76eff9 100644
--- a/api-ref/source/clusters.inc
+++ b/api-ref/source/clusters.inc
@@ -40,6 +40,8 @@ Request Parameters
   - name: name_query
   - status: status_query
 
+The sorting key is ``enabled``.
+
 Response Parameters
 -------------------
 
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 811a16b61..a7d10e2a9 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -176,7 +176,8 @@ name_query:
   type: string
   in: query
   description: |
-    Filters the response by the ``name`` property of the object.
+    Filters the response by the specified ``name`` property of the object,
+    such as ``policy_name`` or ``name`` property of cluster.
 
 oid_query:
   type: string
@@ -261,7 +262,9 @@ type_query:
   type: string
   in: query
   description: |
-    Filters the response by the ``type`` property of the object.
+    Filters the response by the specified ``type`` property of the object,
+    such as ``policy_type`` property of cluster-policy binding object or
+    ``type`` property of policy object.
 
 user_query:
   type: UUID
diff --git a/api-ref/source/policies.inc b/api-ref/source/policies.inc
index 658c74b3e..3737cbd9b 100644
--- a/api-ref/source/policies.inc
+++ b/api-ref/source/policies.inc
@@ -40,6 +40,9 @@ Request Parameters
   - name: name_query
   - type: type_query
 
+The sorting keys include ``name``, ``type``, ``created_at`` and
+``udpated_at``.
+
 Response Parameters
 -------------------