From 489cee10a568e6f27f6c1114ac5e71842e1e9410 Mon Sep 17 00:00:00 2001
From: Erik Wilson <erik.wilson@rackspace.com>
Date: Thu, 22 Jan 2015 14:49:45 -0600
Subject: [PATCH] Adds Discoverability topic to End User Guide

This topics lists the features that may not be enabled for the
customer's Object Storage install. With the moving of the Object
Storage API content from a long-form dev guide to a specification,
some topics needed to be added to the End User Guide.

Change-Id: Idc2b9bef58c9e1ddecf888b30fc2f4825dba3395
Partial-bug: 1392382
---
 doc/user-guide/section_cli_swift_howto.xml    |  1 +
 .../section_object-api-discoverability.xml    | 49 +++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 doc/user-guide/section_object-api-discoverability.xml

diff --git a/doc/user-guide/section_cli_swift_howto.xml b/doc/user-guide/section_cli_swift_howto.xml
index 6e9c720489..963f971113 100644
--- a/doc/user-guide/section_cli_swift_howto.xml
+++ b/doc/user-guide/section_cli_swift_howto.xml
@@ -129,6 +129,7 @@ X-Timestamp: 1392684036.33306</computeroutput></screen>
     </itemizedlist>
   </section>
   <xi:include href="section_object-api-env-vars.xml"/>
+  <xi:include href="section_object-api-discoverability.xml"/>
   <xi:include href="section_object-api-versioning.xml"/>
   <xi:include href="section_object-api-response-formats.xml"/>
   <xi:include href="section_object-api-create-large-objects.xml"/>
diff --git a/doc/user-guide/section_object-api-discoverability.xml b/doc/user-guide/section_object-api-discoverability.xml
new file mode 100644
index 0000000000..5a56ad01f1
--- /dev/null
+++ b/doc/user-guide/section_object-api-discoverability.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section [ <!ENTITY % openstack SYSTEM "../common/entities/openstack.ent"> %openstack; ]>
+<section xmlns="http://docbook.org/ns/docbook"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
+    xml:id="discoverability">
+    <title>Discoverability</title>
+    <para>Your Object Storage system might not enable all features
+        that this document describes. These features are:</para>
+    <itemizedlist role="compact">
+        <listitem>
+            <para><xref linkend="large-object-creation"/></para>
+        </listitem>
+        <listitem>
+            <para><xref linkend="archive-auto-extract"/></para>
+        </listitem>
+        <listitem>
+            <para><xref linkend="static-website"/></para>
+        </listitem>
+    </itemizedlist>
+    <para>To discover which features are enabled in your Object
+        Storage system, use the <literal>/info</literal> request.</para>
+    <para>To use the <literal>/info</literal> request, send a &GET;
+        request using the <literal>/info</literal> path to the Object
+        Store endpoint as shown in this example:</para>
+    <screen><prompt>$</prompt> <userinput>curl https://storage.example.com/info</userinput></screen>
+    <para>This example shows a truncated response body:</para>
+    <programlisting language="json">{
+   "swift":{
+      "version":"1.11.0"
+   },
+   "staticweb":{
+
+   },
+   "tempurl":{
+
+   }
+}</programlisting>
+    <para>This output shows that the Object Storage system has enabled
+        the static website and temporary URL features.</para>
+    <?sbr?>
+    <note>
+        <para>In some cases, the <literal>/info</literal> request will
+            return an error. This could be because your service
+            provider has disabled the <literal>/info</literal> request
+            function, or because you are using an older version that
+            does not support it.</para>
+    </note>
+</section>