openstack/api-site
Code Issues Proposed changes

Document API changes for stack tags in Heat

Browse Source 
Change-Id: I4a59f79720715d6469433f0aa4d1d96f030cfc1b
This commit is contained in:
Jason Dunsmore
2015-05-18 12:32:59 -05:00
committed by Diane Fleming
parent f669f1fd2e
commit 297ebcb4cb
4 changed files with 69 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
api-ref/src/wadls/orchestration-api/src/v1/common.ent
View File

@@ -125,12 +125,12 @@
The stack template on which to perform the specified operation.
</para>
<para>
This parameter is always provided as a <code>string</code> in the
JSON request body. The content of the string is an Orchestration
template in YAML or JSON format.
This parameter is always provided as a <code>string</code> in the JSON
request body. The content of the string is a YAML- or JSON-formatted
Orchestration template.
</para>
<para>
This parameter is only required when you omit the
This parameter is required only when you omit the
<code>template_url</code> parameter. If you specify both parameters,
this value overrides the <code>template_url</code> parameter value.
</para>
@@ -158,3 +158,15 @@
</para>
</wadl:doc>
</param>'>
<!ENTITY tagsParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="tags" style="plain" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more simple string tags to associate with the stack. To associate
multiple tags with a stack, separate the tags with commas. For example,
<code>tag1,tag2</code>.
</para>
</wadl:doc>
</param> '>

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

@@ -337,6 +337,46 @@
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="tags" 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>
Lists stacks that contain one or more simple string tags. To
specify multiple tags, separate the tags with commas. For example,
<code>tag1,tag2</code>. The boolean AND expression is used to combine multiple tags.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="tags_any" 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>
Lists stacks that contain one or more simple string tags. To
specify multiple tags, separate the tags with commas. For example,
<code>tag1,tag2</code>. The boolean OR expression is used to combine multiple tags.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="not_tags" 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>
Lists stacks that do not contain one or more simple string tags. To
specify multiple tags, separate the tags with commas. For example,
<code>tag1,tag2</code>. The boolean AND expression is used to combine multiple tags.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="not_tags_any" 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>
Lists stacks that do not contain one or more simple string tags. To
specify multiple tags, separate the tags with commas. For example,
<code>tag1,tag2</code>. The boolean OR expression is used to combine multiple tags.
</para>
</wadl:doc>
</param>
&sortDirection;
</representation>
</request>
@@ -369,12 +409,11 @@
A name for the new stack.
</para>
<para>
The value must be unique within a project. The name
must start with an ASCII letter and can contain
ASCII letters, digits, underscores, periods, and
hyphens. Specifically, the name must match the
<code>^[a-zA-Z][a-zA-Z0-9_.-]*$</code> regular
expression.
The value must be unique within a project. The name must
start with an ASCII letter and can contain ASCII letters,
digits, underscores, periods, and hyphens. Specifically, the
name must match the <code>^[a-zA-Z][a-zA-Z0-9_.-]*$</code>
regular expression.
</para>
<para>
When you delete or abandon a stack, its name might
@@ -387,6 +426,7 @@
&templateParameter;
&filesParameter;
&parametersParameter;
&tagsParameter;
</representation>
</request>
<response status="201">
@@ -961,6 +1001,7 @@
&templateParameter;
&environmentParameter;
&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">

5
api-ref/src/wadls/orchestration-api/src/v1/samples/stack_list_resp.json
View File

@@ -13,7 +13,8 @@
"stack_name": "simple_stack",
"stack_status": "CREATE_COMPLETE",
"stack_status_reason": "Stack CREATE completed successfully",
"updated_time": ""
"updated_time": "",
"tags": ""
}
]
}
}

5
api-ref/src/wadls/orchestration-api/src/v1/samples/stack_show_resp.json
View File

@@ -22,6 +22,7 @@
"stack_status_reason": "Stack CREATE completed successfully",
"template_description": "sample stack",
"timeout_mins": "",
"updated_time": ""
"updated_time": "",
"tags": ""
}
}
}