openstack/api-site
Code Issues Proposed changes

Merge "Add Response table and error responses for showing cluster policy details"

Browse Source
This commit is contained in:
Jenkins 2016-04-28 19:41:46 +00:00 committed by Gerrit Code Review
commit 5d4c1a279f
2 changed files with 85 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
api-ref/src/wadls/clustering-api/src/v1/common.ent
View File

@ -1,3 +1,20 @@
<!ENTITY fault400 '
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault401 '
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml"
element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY fault404 '
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY global_projectRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="global_project" style="query" type="xsd:boolean" required="false">
@ -404,3 +421,67 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY ClusterPoliciesResponseParameters '
<param name="cluster_id" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The UUID of the cluster.
</para>
</wadl:doc>
</param>
<param name="cluster_name" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The name of the cluster.
</para>
</wadl:doc>
</param>
<param name="id" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The UUID of the cluster policy.
</para>
</wadl:doc>
</param>
<param name="policy_id" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The UUID of the policy.
</para>
</wadl:doc>
</param>
<param name="policy_name" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The name of the policy.
</para>
</wadl:doc>
</param>
<param name="cluster_type" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The type of the cluster.
</para>
</wadl:doc>
</param>
<param name="enabled" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The status of the policy.
</para>
</wadl:doc>
</param>'>

4
api-ref/src/wadls/clustering-api/src/v1/wadl/clustering-api.wadl
View File

@ -441,8 +441,12 @@
</para>
<xsdxt:code href="../samples/cluster-policy-show-response.json"/>
</wadl:doc>
&ClusterPoliciesResponseParameters;
</representation>
</response>
&fault400;
&fault401;
&fault404;
</method>
<method name="DELETE" id="deleteCluster">
<wadl:doc xml:lang="EN" title="Delete cluster"