openstack/api-site
Code Issues Proposed changes

Merge "Add filter flag for heat resource-type-list"

Browse Source
This commit is contained in:
Jenkins 2015-11-20 02:29:45 +00:00 committed by Gerrit Code Review
commit a6b7010488
1 changed files with 103 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

177
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"
xml:lang="EN">
<para>
Filters the stack list by a stack ID.
Use this filter multiple times to filter
by multiple IDs.
Filters the stack list by a stack ID. Use this filter
multiple times to filter by multiple IDs.
</para>
</wadl:doc>
</param>
@ -330,9 +329,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Filters the stack list by a status.
Use this filter multiple times to filter
by multiple statuses.
Filters the stack list by a status. Use this filter
multiple times to filter by multiple statuses.
</para>
</wadl:doc>
</param>
@ -340,8 +338,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Filters the stack list by a name.
Use this filter multiple times to filter by multiple names.
Filters the stack list by a name. Use this filter multiple
times to filter by multiple names.
</para>
</wadl:doc>
</param>
@ -387,17 +385,17 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<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
from the list.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="show_nested" style="query" required="false">
<param xmlns="http://wadl.dev.java.net/2009/02" name="show_nested" 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>
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
from the list.
</para>
@ -462,7 +460,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<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
Orchestration <code>policy.json</code> file. Default is
<code>False</code>.
@ -473,7 +471,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<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 query criteria. Default is <code>False</code>.
</para>
@ -493,7 +491,8 @@
&intServerErr;
</method>
<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">
<para role="shortdesc">
Creates a stack.
@ -630,7 +629,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<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>.
</para>
</wadl:doc>
@ -774,8 +773,8 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Time of last stack update in the following format: <code
>YYYY-MM-DDThh:mm:ssTZD</code>, where <code>TZD</code> is
Time of last stack update in the following format:
<code>YYYY-MM-DDThh:mm:ssTZD</code>, where <code>TZD</code> is
the time zone designator.
</para>
</wadl:doc>
@ -1015,12 +1014,13 @@
Finds the canonical URL for a stack.
</para>
<para>
Also works with verbs other than &GET;, so you can perform &PUT;
and &DELETE; operations on a current stack. Set your client to
follow redirects. Note that when redirecting, the request method
should not change, as defined in RFC2626. However, in many clients
the default behavior is to change the method to &GET; when you
receive a 302 because this behavior is ubiquitous in web browsers.
Also works with verbs other than &GET;, so that you can perform
&PUT; and &DELETE; operations on a current stack. Set your client
to follow redirects. When redirecting, the request method should
not change as defined in RFC2626. However, in many clients the
default behavior is to change the method to &GET; when you receive
a <code>302</code> response code because this behavior is
ubiquitous in web browsers.
</para>
</wadl:doc>
<response status="302">
@ -1066,7 +1066,9 @@
<response status="200">
<representation mediaType="application/json">
<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"/>
</wadl:doc>
</representation>
@ -1094,7 +1096,8 @@
&environmentParameterOptional;
&filesParameter;
&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"
xml:lang="EN">
<para>
@ -1109,14 +1112,14 @@
of this parameter. In the example, <code>a</code> and
<code>b</code> are the names of two parameters defined in
the template.
<programlisting language="json">{ ...
</para>
<programlisting language="json">{ ...
"parameters": {
"a": "Value",
"b": "3"
}
... }
</programlisting>
</para>
</programlisting>
<para>
While the service accepts JSON numbers for parameters with
the type <code>number</code> and JSON objects for parameters
@ -1153,48 +1156,49 @@
&intServerErr;
</method>
<method name="PUT" id="stack_update_preview">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Preview stack update">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Preview stack update">
<para role="shortdesc">
Previews an update for a stack.
</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<xsdxt:code href="samples/stack_update.json"/>
</wadl:doc>
&templateUrlParameter;
&templateParameter;
&environmentParameterOptional;
&filesParameter;
&tagsParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="parameters" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
This parameter supplies updated arguments for
parameters defined in the stack template.
</para>
<para>
The value is a JSON object, where each key is the name of a
parameter defined in the template and the associated value
is the argument to use for that parameter when instantiating
the template. The following code shows the general structure
of this parameter. In the example, <code>a</code> and
<code>b</code> are the names of two parameters defined in
the template.
<programlisting language="json">{ ...
</wadl:doc>
<request>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<xsdxt:code href="samples/stack_update.json"/>
</wadl:doc>
&templateUrlParameter;
&templateParameter;
&environmentParameterOptional;
&filesParameter;
&tagsParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="parameters" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Supplies updated arguments for parameters that are
defined in the stack template.
</para>
<para>
The value is a JSON object, where each key is the name of
a parameter defined in the template and the associated
value is the argument to use for that parameter when
instantiating the template. The following code shows the
general structure of this parameter. In the example,
<code>a</code> and <code>b</code> are the names of two
parameters defined in the template.
</para>
<programlisting language="json">{ ...
"parameters": {
"a": "Value",
"b": "3"
}
... }
</programlisting>
</para>
<para>
</programlisting>
<para>
While the service accepts JSON numbers for parameters with
the type <code>number</code> and JSON objects for parameters
with the type <code>json</code>, all parameter values are
@ -1479,20 +1483,45 @@
</wadl:doc>
<request>
<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"
name="support_status" 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 resource types by a support status. Valid
support status values are <code>UNKNOWN</code>,
<code>SUPPORTED</code>, <code>DEPRECATED</code>,
<code>UNSUPPORTED</code>, and <code>HIDDEN</code>. Use this
filter multiple times to filter by multiple support
statuses.
</para>
</wadl:doc>
<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 a support
status. Valid support status values are
<code>UNKNOWN</code>, <code>SUPPORTED</code>,
<code>DEPRECATED</code>, <code>UNSUPPORTED</code>, and
<code>HIDDEN</code>. Use this filter multiple times to
filter by multiple support statuses.
</para>
</wadl:doc>
</param>
</representation>
</request>