openstack/api-site
Code Issues Proposed changes

Add filter flag for heat resource-type-list

Browse Source 
Add filter flag (name, version)

Ref.
list_resource_types
28b9faac98/heat/engine/service.py (L1168)

Change-Id: Idcf53b39aa30f49887d8faf743cb7b67b72842ee
Closes-Bug: #1493657
This commit is contained in:
Atsushi SAKAI
2015-11-12 16:45:43 +09:00
committed by Diane Fleming
parent 88623138e4
commit a0c125e3c2
1 changed files with 103 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

113
api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl
View File

@@ -320,9 +320,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Filters the stack list by a stack ID. Filters the stack list by a stack ID. Use this filter
Use this filter multiple times to filter multiple times to filter by multiple IDs.
by multiple IDs.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
@@ -330,9 +329,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Filters the stack list by a status. Filters the stack list by a status. Use this filter
Use this filter multiple times to filter multiple times to filter by multiple statuses.
by multiple statuses.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
@@ -340,8 +338,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Filters the stack list by a name. Filters the stack list by a name. Use this filter multiple
Use this filter multiple times to filter by multiple names. times to filter by multiple names.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>
@@ -387,7 +385,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Specifies whether to include deleted stacks in the list. Set to <code>True</code> to include deleted stacks in the list.
Default is <code>False</code>, which excludes deleted stacks Default is <code>False</code>, which excludes deleted stacks
from the list. from the list.
</para> </para>
@@ -397,7 +395,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Specifies whether to include nested stacks in the list. Set to <code>True</code> to include nested stacks in the list.
Default is <code>False</code>, which excludes nested stacks Default is <code>False</code>, which excludes nested stacks
from the list. from the list.
</para> </para>
@@ -462,7 +460,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Specifies whether to include stacks from all tenants in Set to <code>True</code> to include stacks from all tenants in
the stack list. Specify policy requirements in the the stack list. Specify policy requirements in the
Orchestration <code>policy.json</code> file. Default is Orchestration <code>policy.json</code> file. Default is
<code>False</code>. <code>False</code>.
@@ -473,7 +471,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Specifies whether to include a count key in the response. Set to <code>True</code> to include a count key in the response.
The count key value is the number of stacks that match The count key value is the number of stacks that match
the query criteria. Default is <code>False</code>. the query criteria. Default is <code>False</code>.
</para> </para>
@@ -493,7 +491,8 @@
&intServerErr; &intServerErr;
</method> </method>
<method name="POST" id="stack_create"> <method name="POST" id="stack_create">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN" xmlns:wadl="http://wadl.dev.java.net/2009/02"
title="Create stack"> title="Create stack">
<para role="shortdesc"> <para role="shortdesc">
Creates a stack. Creates a stack.
@@ -630,7 +629,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02" <wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
A reference to the stack's parent. If no parent, A reference to the parent of the stack. If no parent,
reference is <code>self</code>. reference is <code>self</code>.
</para> </para>
</wadl:doc> </wadl:doc>
@@ -774,8 +773,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Time of last stack update in the following format: <code Time of last stack update in the following format:
>YYYY-MM-DDThh:mm:ssTZD</code>, where <code>TZD</code> is <code>YYYY-MM-DDThh:mm:ssTZD</code>, where <code>TZD</code> is
the time zone designator. the time zone designator.
</para> </para>
</wadl:doc> </wadl:doc>
@@ -1015,12 +1014,13 @@
Finds the canonical URL for a stack. Finds the canonical URL for a stack.
</para> </para>
<para> <para>
Also works with verbs other than &GET;, so you can perform &PUT; Also works with verbs other than &GET;, so that you can perform
and &DELETE; operations on a current stack. Set your client to &PUT; and &DELETE; operations on a current stack. Set your client
follow redirects. Note that when redirecting, the request method to follow redirects. When redirecting, the request method should
should not change, as defined in RFC2626. However, in many clients not change as defined in RFC2626. However, in many clients the
the default behavior is to change the method to &GET; when you default behavior is to change the method to &GET; when you receive
receive a 302 because this behavior is ubiquitous in web browsers. a <code>302</code> response code because this behavior is
ubiquitous in web browsers.
</para> </para>
</wadl:doc> </wadl:doc>
<response status="302"> <response status="302">
@@ -1066,7 +1066,9 @@
<response status="200"> <response status="200">
<representation mediaType="application/json"> <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"> <wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para xmlns="http://docbook.org/ns/docbook">Returns the template for a stack.</para> <para xmlns="http://docbook.org/ns/docbook">
Returns the template for a stack.
</para>
<xsdxt:code href="samples/template_show_resp.json"/> <xsdxt:code href="samples/template_show_resp.json"/>
</wadl:doc> </wadl:doc>
</representation> </representation>
@@ -1094,7 +1096,8 @@
&environmentParameterOptional; &environmentParameterOptional;
&filesParameter; &filesParameter;
&tagsParameter; &tagsParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="parameters" style="plain" required="false"> <param xmlns="http://wadl.dev.java.net/2009/02"
name="parameters" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"> xml:lang="EN">
<para> <para>
@@ -1109,6 +1112,7 @@
of this parameter. In the example, <code>a</code> and of this parameter. In the example, <code>a</code> and
<code>b</code> are the names of two parameters defined in <code>b</code> are the names of two parameters defined in
the template. the template.
</para>
<programlisting language="json">{ ... <programlisting language="json">{ ...
"parameters": { "parameters": {
"a": "Value", "a": "Value",
@@ -1116,7 +1120,6 @@
} }
... } ... }
</programlisting> </programlisting>
</para>
<para> <para>
While the service accepts JSON numbers for parameters with While the service accepts JSON numbers for parameters with
the type <code>number</code> and JSON objects for parameters the type <code>number</code> and JSON objects for parameters
@@ -1171,21 +1174,23 @@
&environmentParameterOptional; &environmentParameterOptional;
&filesParameter; &filesParameter;
&tagsParameter; &tagsParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="parameters" style="plain" required="false"> <param xmlns="http://wadl.dev.java.net/2009/02"
name="parameters" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"> xml:lang="EN">
<para> <para>
This parameter supplies updated arguments for Supplies updated arguments for parameters that are
parameters defined in the stack template. defined in the stack template.
</para> </para>
<para> <para>
The value is a JSON object, where each key is the name of a The value is a JSON object, where each key is the name of
parameter defined in the template and the associated value a parameter defined in the template and the associated
is the argument to use for that parameter when instantiating value is the argument to use for that parameter when
the template. The following code shows the general structure instantiating the template. The following code shows the
of this parameter. In the example, <code>a</code> and general structure of this parameter. In the example,
<code>b</code> are the names of two parameters defined in <code>a</code> and <code>b</code> are the names of two
the template. parameters defined in the template.
</para>
<programlisting language="json">{ ... <programlisting language="json">{ ...
"parameters": { "parameters": {
"a": "Value", "a": "Value",
@@ -1193,7 +1198,6 @@
} }
... } ... }
</programlisting> </programlisting>
</para>
<para> <para>
While the service accepts JSON numbers for parameters with While the service accepts JSON numbers for parameters with
the type <code>number</code> and JSON objects for parameters the type <code>number</code> and JSON objects for parameters
@@ -1479,18 +1483,43 @@
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Filters the response by a resource type name. You can set
this value to a regular expression. Use this filter
multiple times to filter by multiple names.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="version" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Filters the response by resource types by heat version.
For example, <code>2015.1</code> or <code>5.0.0</code>.
Use this filter multiple times to filter by multiple
versions.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" <param xmlns="http://wadl.dev.java.net/2009/02"
name="support_status" style="query" required="false"> name="support_status" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook" <wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN"> xml:lang="EN">
<para> <para>
Filters the resource types by a support status. Valid Filters the response by resource types by a support
support status values are <code>UNKNOWN</code>, status. Valid support status values are
<code>SUPPORTED</code>, <code>DEPRECATED</code>, <code>UNKNOWN</code>, <code>SUPPORTED</code>,
<code>UNSUPPORTED</code>, and <code>HIDDEN</code>. Use this <code>DEPRECATED</code>, <code>UNSUPPORTED</code>, and
filter multiple times to filter by multiple support <code>HIDDEN</code>. Use this filter multiple times to
statuses. filter by multiple support statuses.
</para> </para>
</wadl:doc> </wadl:doc>
</param> </param>