openstack/api-site
Code Issues Proposed changes

Merge "Compute v2.1 docs clean up (part16) (os-hide-server-addresses)"

Browse Source
This commit is contained in:
Jenkins 2015-09-30 14:27:40 +00:00 committed by Gerrit Code Review
commit f5d0970098
3 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/src/docbkx/ch_compute-v2.1.xml
View File

@ -236,6 +236,13 @@
Shows <code>OS-SRV-USG:launched_at</code> and <code>OS-SRV- Shows <code>OS-SRV-USG:launched_at</code> and <code>OS-SRV-
USG:terminated_at</code> attributes in server responses. USG:terminated_at</code> attributes in server responses.
</para> </para>
<para>
To hide <code>addresses</code> information for instances in a
specified state, set the
<code>osapi_hide_server_address_states</code> configuration option.
Set this option to a valid VM state in the <code>nova.conf</code>
configuration file.
</para>
<wadl:resources <wadl:resources
href="../wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl" href="../wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl"
xmlns:wadl="http://wadl.dev.java.net/2009/02"/> xmlns:wadl="http://wadl.dev.java.net/2009/02"/>

12
api-ref/src/wadls/compute-api/src/v2.1/common.ent
View File

@ -668,6 +668,18 @@
</para> </para>
</wadl:doc> </wadl:doc>
</param>'> </param>'>
<!ENTITY serverAddressResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="addresses"
style="plain" required="true" type="xsd:dict" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The addresses for the server. If <code>osapi_hide_server_address_states</code> is set,
addresses information is hidden for any server in the specified state. By default,
servers in <code>BUILDING</code> state hide their addresses information.
</para>
</wadl:doc>
</param>'>
<!-- Servers Extended Attributes Parameters --> <!-- Servers Extended Attributes Parameters -->
<!ENTITY GetListServersDetailQueryParameters ' <!ENTITY GetListServersDetailQueryParameters '
&changes_since-QueryParameter;'> &changes_since-QueryParameter;'>

2
api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl
View File

@ -48,6 +48,7 @@
</wadl:doc> </wadl:doc>
&x-openstack-request-idHeader; &x-openstack-request-idHeader;
&serverListDetailsResponseParameters; &serverListDetailsResponseParameters;
&serverAddressResponseParameters;
</representation> </representation>
</response> </response>
</method> </method>
@ -72,6 +73,7 @@
</wadl:doc> </wadl:doc>
&x-openstack-request-idHeader; &x-openstack-request-idHeader;
&serverListDetailsResponseParameters; &serverListDetailsResponseParameters;
&serverAddressResponseParameters;
</representation> </representation>
</response> </response>
</method> </method>