object-api/openstack-object-storage-dev/section_object-api-discoverability.xml
Diane Fleming ed4f3c4db9 Update Object Storage API Reference
Point to WADL files that generate the API Reference
  page so that the method descriptions and request
  and response parameters are consistent between
  these two docs:
    http://api.openstack.org/api-ref-objectstorage.html
      (API Reference page for Object Storage)
    http://docs.openstack.org/api/openstack-object-storage/1.0/
      (API Reference (or spec) for Object Storage)

Add descriptions of ACLs, FormPOST, TempURLs,
  StaticWeb, Bulk Upload, Bulk Delete, the OPTIONS operation
  (though this is implicit in CORS support)

Validate all code examples

Remove duplication.

Co-Author: Donagh McCabe

Closes-Bug: #1187119
Closes-Bug: #1214139
Closes-Bug: #1074198
Partial-Bug: #1255770

Change-Id: I94054b046a94260ba8825bdb42439adfcaf9fdce
author: diane fleming
2014-02-13 14:47:19 -06:00

67 lines
2.5 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section [
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
]>
<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="expire-objects"/></para>
</listitem>
<listitem>
<para><xref linkend="archive-auto-extract"/></para>
</listitem>
<listitem>
<para><xref linkend="bulk-delete"/></para>
</listitem>
<listitem>
<para><xref linkend="container-sync"/></para>
</listitem>
<listitem>
<para><xref linkend="container-quotas"/></para>
</listitem>
<listitem>
<para><xref linkend="tempurl"/></para>
</listitem>
<listitem>
<para><xref linkend="form-post"/></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.
However, your service provider might have disabled the
<literal>/info</literal> request, or you might be using an
older version that does not support 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.clouddrive.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>
</section>