ed4f3c4db9
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
39 lines
1.6 KiB
XML
39 lines
1.6 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<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="env-vars">
|
|
<title>Environment variables required to run examples</title>
|
|
<para>To run the cURL command examples for the Object Storage API
|
|
requests, set these environment variables:</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para><literal>publicURL</literal>. The public URL that is
|
|
the HTTP endpoint from where you can access Object
|
|
Storage. It includes the Object Storage API version
|
|
number and your account name. For example,
|
|
<code>https://23.253.72.207/v1/my_account</code>.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para><literal>token</literal>. The authentication token
|
|
for Object Storage.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
<para>To obtain these values, run the <command>swift stat
|
|
-v</command> command.</para>
|
|
<para>As shown in this example, the public URL appears in the
|
|
<literal>StorageURL</literal> field, and the token appears
|
|
in the <literal>Auth Token</literal> field:</para>
|
|
<programlisting>StorageURL: https://23.253.72.207/v1/my_account
|
|
Auth Token: {token}
|
|
Account: my_account
|
|
Containers: 2
|
|
Objects: 3
|
|
Bytes: 47
|
|
Meta Book: MobyDick
|
|
X-Timestamp: 1389453423.35964
|
|
X-Trans-Id: txee55498935404a2caad89-0052dd3b77
|
|
Content-Type: text/plain; charset=utf-8
|
|
Accept-Ranges: bytes</programlisting>
|
|
</section>
|