openstack/api-site
Code Issues Proposed changes

Merge "Added description of the disable_rollback argument to stack_create"

Browse Source
This commit is contained in:
Jenkins
2014-01-23 14:49:38 +00:00
committed by Gerrit Code Review
parent 851955f015 409fedf96b
commit 3bc5e52ae2
1 changed files with 43 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -138,67 +138,56 @@
<param name="status" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Filters the stack list by the specified status.
You can use this filter multiple times to
filter by multiple statuses.
</para>
<para>Filters the stack list by the specified
status. You can use this filter multiple times
to filter by multiple statuses.</para>
</wadl:doc>
</param>
<param name="name" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Filters the stack list by the specified name.
</para>
<para>Filters the stack list by the specified
name.</para>
</wadl:doc>
</param>
<param name="limit" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Limits the number of stacks that appear on a
page to this value. The typical
pattern of limit and marker is to make an
initial limited request and then to use the ID
of the last stack from the response as the
marker parameter in a subsequent limited
request.
</para>
<para>Limits the number of stacks that appear on
a page to this value. The typical pattern of
limit and marker is to make an initial limited
request and then to use the ID of the last
stack from the response as the marker
parameter in a subsequent limited request.</para>
</wadl:doc>
</param>
<param name="marker" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Specifies the ID of the last-seen stack. The
typical pattern of limit and marker is to make
an initial limited request and then to use the
ID of the last stack from the response as the
marker parameter in a subsequent limited
request.
</para>
<para>Specifies the ID of the last-seen stack.
The typical pattern of limit and marker is to
make an initial limited request and then to
use the ID of the last stack from the response
as the marker parameter in a subsequent
limited request.</para>
</wadl:doc>
</param>
<param name="sort_keys" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Sorts the stack list by one of these attributes:
<code>name</code>, <code>status</code>,
<code>created_at</code>, or
<code>updated_at</code>.
</para>
<para>Sorts the stack list by one of these
attributes: <code>name</code>,
<code>status</code>,
<code>created_at</code>, or
<code>updated_at</code>.</para>
</wadl:doc>
</param>
<param name="sort_dir" style="query" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
The sort direction of the stack list. Either
<code>asc</code> (ascending) or
<code>desc</code> (descending).
</para>
<para>The sort direction of the stack list.
Either <code>asc</code> (ascending) or
<code>desc</code> (descending).</para>
</wadl:doc>
</param>
</request>
@@ -219,13 +208,13 @@
<param name="template_url" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The URL of the template to
instantiate. This is ignored if the template
instantiate. This value is ignored if the template
is supplied inline.</para></wadl:doc>
</param>
<param name="template" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A JSON template to
instantiate. This takes precedence over the
instantiate. This value takes precedence over the
template URL if both are
supplied.</para></wadl:doc>
</param>
@@ -256,6 +245,15 @@
xml:lang="EN"><para>The timeout for stack creation
in minutes.</para></wadl:doc>
</param>
<param name="disable_rollback" style="plain"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>Controls whether a failure
during stack creation causes deletion of all
previously-created resources in that stack.
The default is True; a failure does not cause
deletions.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
@@ -268,7 +266,7 @@
<method name="POST" id="stack_action_suspend">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Stack action suspend">
<para role="shortdesc">Suspends the stack.</para>
<para role="shortdesc">Suspends a stack.</para>
</wadl:doc>
<request>
<param name="suspend" style="plain" required="true">
@@ -350,13 +348,13 @@
<param name="template_url" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The URL of the template to
instantiate. This is ignored if the template
instantiate. This value is ignored if the template
is supplied inline.</para></wadl:doc>
</param>
<param name="template" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A JSON template to
instantiate. This takes precedence over the
instantiate. This value takes precedence over the
template URL if both are
supplied.</para></wadl:doc>
</param>
@@ -413,13 +411,13 @@
<param name="template_url" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The URL of the template to
instantiate. This is ignored if the template
instantiate. This value is ignored if the template
is supplied inline.</para></wadl:doc>
</param>
<param name="template" style="plain" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>A JSON template to
instantiate. Takes precedence over the
instantiate. This value takes precedence over the
template URL if both are
supplied.</para></wadl:doc>
</param>
@@ -533,9 +531,8 @@
<method name="GET" id="build_info_show">
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Show build information">
<para role="shortdesc">
Shows build information for the heat deployment.
</para>
<para role="shortdesc">Shows build information for the
heat deployment.</para>
</wadl:doc>
<response status="200">
<representation mediaType="application/json">