From bb1210a0b892db59a4d925fbf0ffe9e7beba1329 Mon Sep 17 00:00:00 2001
From: tengqm <tengqim@cn.ibm.com>
Date: Tue, 3 Mar 2015 13:24:23 +0800
Subject: [PATCH] Updated API doc for policy_update

---
 .../clustering-api/src/v1/clustering-api.wadl | 46 +++++++++++++------
 .../src/v1/samples/policy_update.json         |  6 ++-
 .../src/v1/samples/policy_update_resp.json    | 19 ++++++++
 3 files changed, 56 insertions(+), 15 deletions(-)
 create mode 100644 doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update_resp.json

diff --git a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
index 42bf63619..92277658b 100644
--- a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
+++ b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
@@ -951,24 +951,44 @@ name could be delayed for an unspecified time.</para></note>'>
                 <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
                     <xsdxt:code href="samples/policy_update.json"/>
                 </wadl:doc>
-                <param name="name" style="plain" required="false">
+                <param name="policy" style="plain" required="true">
                     <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
-                        <para>New name, if specified, for the target policy.</para>
-                    </wadl:doc>
-                </param>
-                <param name="spec" style="plain" required="false">
-                    <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
-                        <para>Detailed specification based on the chosen policy type.</para>
-                    </wadl:doc>
-                </param>
-                <param name="level" style="plain" required="false">
-                    <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
-                        <para>A new default enforcement level for the policy.</para>
+                        <para>A map that contains the following keys and values that specify
+                            the details of the policy to be updated:</para>
+                        <itemizedlist xml:id="policy_update_body">
+                            <title>Policy body</title>
+                            <listitem>
+                                <para>
+                                    <code>name</code> New name for the policy, if specified.
+                                </para>
+                            </listitem>
+                            <listitem>
+                                <para>
+                                    <code>level</code> New enforcement level for the policy, if specified.
+                                </para>
+                            </listitem>
+                            <listitem>
+                                <para>
+                                    <code>cooldown</code> New cooldown seconds for the policy, if specified.
+                                </para>
+                            </listitem>
+                        </itemizedlist>
                     </wadl:doc>
                 </param>
             </representation>
         </request>
-        <response status="202"/>
+        <response status="200">
+            <representation mediaType="application/json">
+                <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
+                    <para>A policy record that contains fields like <code>id</code>,
+                        <code>name</code>, <code>type</code>, <code>spec</code>, <code>level</code>,
+                        <code>cooldown</code>, <code>created_time</code>, <code>updated_time</code>,
+                        <code>deleted_time</code> etc.
+                    </para>
+                    <xsdxt:code href="samples/policy_update_resp.json"/>
+                </wadl:doc>
+            </representation>
+        </response>
     </method>
     <method name="DELETE" id="policy_delete">
         <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete policy">
diff --git a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update.json b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update.json
index 2b81f7630..230d5e3c6 100644
--- a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update.json
+++ b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update.json
@@ -1,5 +1,7 @@
 {
-    "spec": {
-        "criteria": "youngest_first",
+    "policy": {
+        "cooldown": "34",
+	"level": null,
+	"name": null
     },
 }
diff --git a/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update_resp.json b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update_resp.json
new file mode 100644
index 000000000..6b4c04999
--- /dev/null
+++ b/doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update_resp.json
@@ -0,0 +1,19 @@
+{
+    "policy": {
+        "cooldown": 34,
+        "created_time": "2015-02-10T12:37:48.000000",
+        "data": {},
+        "deleted_time": null,
+        "id": "714fe676-a08f-4196-b7af-61d52eeded15",
+        "level": 0,
+        "name": "dp01",
+        "spec": {
+            "criteria": "OLDEST_FIRST",
+            "destroy_after_deletion": true,
+            "grace_period": 60,
+            "reduce_desired_capacity": false
+        },
+        "type": "DeletionPolicy",
+        "updated_time": "2015-03-03T05:18:24.000000"
+    }
+}