openstack/senlin
Code Issues Proposed changes

Updated API doc for policy_update

Browse Source
This commit is contained in:
tengqm 2015-03-03 13:24:23 +08:00
parent b9a15aeb78
commit bb1210a0b8
3 changed files with 56 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/clustering-api.wadl
View File

@ -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">

6
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update.json
View File

@ -1,5 +1,7 @@
{
"spec": {
"criteria": "youngest_first",
"policy": {
"cooldown": "34",
"level": null,
"name": null
},
}

19
doc/api-site/api-ref/src/wadls/clustering-api/src/v1/samples/policy_update_resp.json Normal file
View File

@ -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"
}
}