From 2c8cf8ea56f73bbf7e5148a1b045c5810066a83e Mon Sep 17 00:00:00 2001
From: Atsushi SAKAI <sakaia@jp.fujitsu.com>
Date: Fri, 25 Sep 2015 14:29:54 +0900
Subject: [PATCH] Compute v2.1 docs clean up (part16)
 (os-hide-server-addresses)

  WADL file is a server usage one (just add description)
  JSON files are not changed.

  In my understanding, #1488144 is closed by this ticket.

Change-Id: I087192a4c19f3752c3ee80d6bc3fe7fce90b606e
Closes-Bug: #1488144
---
 api-ref/src/docbkx/ch_compute-v2.1.xml               |  7 +++++++
 api-ref/src/wadls/compute-api/src/v2.1/common.ent    | 12 ++++++++++++
 .../src/v2.1/wadl/os-server-usage-v2.1.wadl          |  2 ++
 3 files changed, 21 insertions(+)

diff --git a/api-ref/src/docbkx/ch_compute-v2.1.xml b/api-ref/src/docbkx/ch_compute-v2.1.xml
index ab619aa8d..55debfbdc 100644
--- a/api-ref/src/docbkx/ch_compute-v2.1.xml
+++ b/api-ref/src/docbkx/ch_compute-v2.1.xml
@@ -236,6 +236,13 @@
          Shows <code>OS-SRV-USG:launched_at</code> and <code>OS-SRV-
          USG:terminated_at</code> attributes in server responses.
       </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
          href="../wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl"
          xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/common.ent b/api-ref/src/wadls/compute-api/src/v2.1/common.ent
index a36a1ad6a..8cde5038b 100644
--- a/api-ref/src/wadls/compute-api/src/v2.1/common.ent
+++ b/api-ref/src/wadls/compute-api/src/v2.1/common.ent
@@ -668,6 +668,18 @@
    </para>
 </wadl:doc>
 </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 -->
 <!ENTITY GetListServersDetailQueryParameters '
 &changes_since-QueryParameter;'>
diff --git a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl
index ffd09d5b3..489d4c0c0 100644
--- a/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl
+++ b/api-ref/src/wadls/compute-api/src/v2.1/wadl/os-server-usage-v2.1.wadl
@@ -48,6 +48,7 @@
                 </wadl:doc>
                 &x-openstack-request-idHeader;
                 &serverListDetailsResponseParameters;
+                &serverAddressResponseParameters;
             </representation>
         </response>
     </method>
@@ -72,6 +73,7 @@
                 </wadl:doc>
                 &x-openstack-request-idHeader;
                 &serverListDetailsResponseParameters;
+                &serverAddressResponseParameters;
             </representation>
         </response>
     </method>