openstack-attic/object-api
Code Issues Proposed changes

Remove extra whitespace

Browse Source 
Cleanup extraneous whitespace like end of line whitespace or whitespace
before </para>.

Change-Id: I83a26dae9f6f7e9af522c2418d64c2efae9d61f1
This commit is contained in:
Andreas Jaeger 2013-12-26 18:50:55 +01:00
parent d299e6a3e7
commit 6e402a3c91
7 changed files with 88 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
openstack-object-storage-dev/ch_object-api-general.xml
View File

@ -44,11 +44,11 @@ format="SVG" scale="60"/>
token HTTP x-header, defined as <code>X-Auth-Token</code>. token HTTP x-header, defined as <code>X-Auth-Token</code>.
Clients obtain this token, along with the Cloud Servers Clients obtain this token, along with the Cloud Servers
API URL, by first using an authentication service and API URL, by first using an authentication service and
supplying a valid username and API access key. </para> supplying a valid username and API access key.</para>
<simplesect> <simplesect>
<title>Request</title> <title>Request</title>
<para>To authenticate, you must supply your username and <para>To authenticate, you must supply your username and
API access key in x-headers: </para> API access key in x-headers:</para>
<para> <para>
<itemizedlist spacing="compact"> <itemizedlist spacing="compact">
<listitem> <listitem>
@ -71,13 +71,13 @@ format="SVG" scale="60"/>
Keystone), or you can use your own Keystone), or you can use your own
authentication system. Place your access authentication system. Place your access
key in the <code>X-Auth-Key</code> key in the <code>X-Auth-Key</code>
x-header. </para> x-header.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para> </para> <para> </para>
<example> <example>
<title>Authentication HTTP Request </title> <title>Authentication HTTP Request</title>
<literallayout class="monospaced"><xi:include href="samples/auth-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/auth-req.txt" parse="text"/></literallayout>
</example> </example>
</simplesect> </simplesect>

6
openstack-object-storage-dev/ch_object-api-overview.xml
View File

@ -37,7 +37,7 @@ format="SVG" scale="60"/>
data. You can store an unlimited quantity of files and each data. You can store an unlimited quantity of files and each
file can be as large as 5 GBs, plus with large object file can be as large as 5 GBs, plus with large object
creation, you can upload and store objects of virtually any creation, you can upload and store objects of virtually any
size. </para> size.</para>
<para>OpenStack Object Storage allows users to store and retrieve <para>OpenStack Object Storage allows users to store and retrieve
files and content through a simple Web Service interface files and content through a simple Web Service interface
(ReST: Representational State Transfer). There are also (ReST: Representational State Transfer). There are also
@ -51,7 +51,7 @@ format="SVG" scale="60"/>
</para> </para>
<para>We welcome feedback, comments, and bug reports at <link <para>We welcome feedback, comments, and bug reports at <link
xlink:href="http://bugs.launchpad.net/swift" xlink:href="http://bugs.launchpad.net/swift"
>http://bugs.launchpad.net/swift</link>. </para> >http://bugs.launchpad.net/swift</link>.</para>
<section xml:id="intended-audience-object-dev-guide"> <section xml:id="intended-audience-object-dev-guide">
<title>Intended Audience</title> <title>Intended Audience</title>
<para>This guide is intended to assist software developers who <para>This guide is intended to assist software developers who
@ -63,7 +63,7 @@ format="SVG" scale="60"/>
here, you should first have a general understanding of the here, you should first have a general understanding of the
OpenStack Object Storage service and have access to an OpenStack Object Storage service and have access to an
installation of OpenStack Object Storage. You should also installation of OpenStack Object Storage. You should also
be familiar with: </para> be familiar with:</para>
<itemizedlist spacing="compact"> <itemizedlist spacing="compact">
<listitem> <listitem>
<para>ReSTful web services</para> <para>ReSTful web services</para>

86
openstack-object-storage-dev/ch_object-api-troubleshooting-examples.xml
View File

@ -41,11 +41,11 @@ format="SVG" scale="60"/>
UNIX®-like environments and Mac OS X® and can be UNIX®-like environments and Mac OS X® and can be
downloaded for Windows®. For more information on cURL, downloaded for Windows®. For more information on cURL,
visit <link xlink:href="http://curl.haxx.se/" visit <link xlink:href="http://curl.haxx.se/"
>http://curl.haxx.se/</link>. </para> >http://curl.haxx.se/</link>.</para>
<para>cURL allows you to transmit and receive HTTP requests <para>cURL allows you to transmit and receive HTTP requests
and responses from the command-line or from within a shell and responses from the command-line or from within a shell
script. This makes it possible to work with the ReST API script. This makes it possible to work with the ReST API
directly without using one of the client APIs. </para> directly without using one of the client APIs.</para>
<para>The following cURL command-line options will be <para>The following cURL command-line options will be
used</para> used</para>
<variablelist> <variablelist>
@ -139,7 +139,7 @@ Content-Type: text/plain
</section> </section>
<section xml:id="listing-and-creating-storage-containers"> <section xml:id="listing-and-creating-storage-containers">
<title>Listing and Creating Containers</title> <title>Listing and Creating Containers</title>
<para> The simplest operation for Object Storage is to simply <para>The simplest operation for Object Storage is to simply
list the containers you have, which when you don't have list the containers you have, which when you don't have
any containers yet isn't terribly exciting:</para> any containers yet isn't terribly exciting:</para>
<example> <example>
@ -150,7 +150,7 @@ Content-Type: text/plain
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -178,7 +178,7 @@ Date: Mon, 07 Nov 2011 17:07:01 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/george</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/george</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 201 Created HTTP/1.1 201 Created
Content-Length: 18 Content-Length: 18
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -201,7 +201,7 @@ Date: Mon, 07 Nov 2011 17:44:20 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -236,7 +236,7 @@ george
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -266,7 +266,7 @@ jerry
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343?limit=2</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343?limit=2</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -294,7 +294,7 @@ dogs
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343?marker=dogs\&amp;limit=2</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343?marker=dogs\&amp;limit=2</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -332,7 +332,7 @@ george
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343?format=json</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343?format=json</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -359,7 +359,7 @@ Date: Mon, 07 Nov 2011 19:17:33 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343?format=xml</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343?format=xml</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -402,11 +402,11 @@ Date: Mon, 07 Nov 2011 19:17:38 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
X-Container-Object-Count: 0 X-Container-Object-Count: 0
X-Container-Bytes-Used: 0 X-Container-Bytes-Used: 0
Accept-Ranges: bytes Accept-Ranges: bytes
X-Trans-Id: tx3dd984f9482341dd97546e9d49d65e90 X-Trans-Id: tx3dd984f9482341dd97546e9d49d65e90
Content-Length: 0 Content-Length: 0
Date: Mon, 07 Nov 2011 20:39:41 GMT Date: Mon, 07 Nov 2011 20:39:41 GMT
@ -424,7 +424,7 @@ Date: Mon, 07 Nov 2011 20:39:41 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/george</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/george</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
Content-Length: 0 Content-Length: 0
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -443,7 +443,7 @@ Date: Mon, 07 Nov 2011 20:42:58 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Account-Object-Count: 0 X-Account-Object-Count: 0
X-Account-Bytes-Used: 0 X-Account-Bytes-Used: 0
@ -480,7 +480,7 @@ jerry
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/jerry</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/jerry</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
X-Container-Object-Count: 0 X-Container-Object-Count: 0
X-Container-Bytes-Used: 0 X-Container-Bytes-Used: 0
@ -505,7 +505,7 @@ Date: Tue, 15 Nov 2011 03:29:22 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/jerry</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/jerry</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 202 Accepted HTTP/1.1 202 Accepted
Content-Length: 58 Content-Length: 58
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -527,7 +527,7 @@ The request is accepted for processing.
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/jerry</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/jerry</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
X-Container-Object-Count: 0 X-Container-Object-Count: 0
X-Container-Read: .r:*,.rlistings X-Container-Read: .r:*,.rlistings
@ -557,7 +557,7 @@ Date: Tue, 15 Nov 2011 03:33:36 GMT
<example> <example>
<title>Sample File Listing</title> <title>Sample File Listing</title>
<screen> <screen>
<computeroutput> <computeroutput>
$ ls -l $ ls -l
total 504 total 504
-rw-r--r--@ 1 petecj2 staff 44765 Nov 7 14:49 JingleRocky.jpg -rw-r--r--@ 1 petecj2 staff 44765 Nov 7 14:49 JingleRocky.jpg
@ -616,7 +616,7 @@ Date: Mon, 07 Nov 2011 22:51:30 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 1 X-Container-Object-Count: 1
X-Container-Read: .r:*,.rlistings X-Container-Read: .r:*,.rlistings
@ -644,7 +644,7 @@ JingleRocky.jpg
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 3 X-Container-Object-Count: 3
X-Container-Read: .r:*,.rlistings X-Container-Read: .r:*,.rlistings
@ -791,7 +791,7 @@ Etag: "0c922c37f915efb1c9b97e6328b3e660"
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs?limit=2</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs?limit=2</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 3 X-Container-Object-Count: 3
X-Container-Read: .r:*,.rlistings X-Container-Read: .r:*,.rlistings
@ -816,7 +816,7 @@ RockyAndBuster.jpg
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs?marker=RockyAndBuster.jpg\&amp;limit=2</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs?marker=RockyAndBuster.jpg\&amp;limit=2</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 3 X-Container-Object-Count: 3
X-Container-Read: .r:*,.rlistings X-Container-Read: .r:*,.rlistings
@ -839,12 +839,12 @@ SittingBuster.jpg
<example> <example>
<title>Removing Local Copies</title> <title>Removing Local Copies</title>
<screen> <screen>
<computeroutput> <computeroutput>
$ ls -l $ ls -l
total 504 total 504
-rw-r--r--@ 1 petecj2 staff 44765 Nov 7 14:49 JingleRocky.jpg -rw-r--r--@ 1 petecj2 staff 44765 Nov 7 14:49 JingleRocky.jpg
-rw-r--r--@ 1 petecj2 staff 100864 Nov 7 14:47 RockyAndBuster.jpg -rw-r--r--@ 1 petecj2 staff 100864 Nov 7 14:47 RockyAndBuster.jpg
-rw-r--r--@ 1 petecj2 staff 107103 Nov 7 14:47 SittingBuster.jpg -rw-r--r--@ 1 petecj2 staff 107103 Nov 7 14:47 SittingBuster.jpg
$ rm JingleRocky.jpg $ rm JingleRocky.jpg
$ ls -l $ ls -l
total 416 total 416
@ -863,7 +863,7 @@ total 416
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg > JingleRocky.jpg</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg > JingleRocky.jpg</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
$ ls -l $ ls -l
total 504 total 504
-rw-r--r-- 1 petecj2 staff 44765 Nov 7 15:11 JingleRocky.jpg -rw-r--r-- 1 petecj2 staff 44765 Nov 7 15:11 JingleRocky.jpg
@ -887,7 +887,7 @@ total 504
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/JingleRocky.jpg</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/JingleRocky.jpg</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 201 Created HTTP/1.1 201 Created
Content-Length: 118 Content-Length: 118
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -924,7 +924,7 @@ Date: Mon, 07 Nov 2011 23:23:54 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 1 X-Container-Object-Count: 1
X-Container-Bytes-Used: 44765 X-Container-Bytes-Used: 44765
@ -948,7 +948,7 @@ JingleRocky.jpg
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/JingleRocky.jpg</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/JingleRocky.jpg</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
Content-Length: 0 Content-Length: 0
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -967,7 +967,7 @@ Date: Mon, 07 Nov 2011 23:32:39 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/elaine/</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
X-Container-Object-Count: 0 X-Container-Object-Count: 0
X-Container-Bytes-Used: 0 X-Container-Bytes-Used: 0
@ -994,7 +994,7 @@ Date: Mon, 07 Nov 2011 23:32:41 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
&lt;html> &lt;html>
&lt;head> &lt;head>
&lt;title>202 Accepted&lt;/title> &lt;title>202 Accepted&lt;/title>
@ -1020,7 +1020,7 @@ Date: Mon, 07 Nov 2011 23:32:41 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/dogs/JingleRocky.jpg</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Object-Meta-Breed: Terrier pit bull mix X-Object-Meta-Breed: Terrier pit bull mix
Last-Modified: Tue, 08 Nov 2011 01:26:49 GMT Last-Modified: Tue, 08 Nov 2011 01:26:49 GMT
@ -1054,7 +1054,7 @@ Date: Mon, 07 Nov 2011 23:32:41 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 201 Created HTTP/1.1 201 Created
Content-Length: 18 Content-Length: 18
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -1074,7 +1074,7 @@ Date: Wed, 16 Nov 2011 00:06:22 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
X-Container-Object-Count: 0 X-Container-Object-Count: 0
X-Container-Bytes-Used: 0 X-Container-Bytes-Used: 0
@ -1096,7 +1096,7 @@ Date: Wed, 16 Nov 2011 00:06:26 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos/terriers/JingleRocky.jpg</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos/terriers/JingleRocky.jpg</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 201 Created HTTP/1.1 201 Created
Content-Length: 118 Content-Length: 118
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -1112,9 +1112,9 @@ Date: Wed, 16 Nov 2011 00:09:19 GMT
&lt;body> &lt;body>
&lt;h1>201 Created&lt;/h1> &lt;h1>201 Created&lt;/h1>
&lt;br />&lt;br /> &lt;br />&lt;br />
&lt;/body> &lt;/body>
&lt;/html> &lt;/html>
</computeroutput> </computeroutput>
@ -1131,7 +1131,7 @@ Date: Wed, 16 Nov 2011 00:09:19 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos/chihuahuas/SittingBuster.jpg</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos/chihuahuas/SittingBuster.jpg</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 201 Created HTTP/1.1 201 Created
Content-Length: 118 Content-Length: 118
Content-Type: text/html; charset=UTF-8 Content-Type: text/html; charset=UTF-8
@ -1164,7 +1164,7 @@ Date: Wed, 16 Nov 2011 00:52:25 GMT
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 2 X-Container-Object-Count: 2
X-Container-Bytes-Used: 151868 X-Container-Bytes-Used: 151868
@ -1174,7 +1174,7 @@ Content-Type: text/plain; charset=utf-8
X-Trans-Id: tx8544a17e8b1e4da693145fb5f2e6db43 X-Trans-Id: tx8544a17e8b1e4da693145fb5f2e6db43
Date: Wed, 16 Nov 2011 00:53:43 GMT Date: Wed, 16 Nov 2011 00:53:43 GMT
chihuahuas/SittingBuster.jpg chihuahuas/SittingBuster.jpg
terriers/JingleRocky.jpg terriers/JingleRocky.jpg
</computeroutput> </computeroutput>
</screen> </screen>
@ -1190,7 +1190,7 @@ terriers/JingleRocky.jpg
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos?path=terriers</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos?path=terriers</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 2 X-Container-Object-Count: 2
X-Container-Bytes-Used: 151868 X-Container-Bytes-Used: 151868
@ -1215,7 +1215,7 @@ terriers/JingleRocky.jpg
<uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos?delimiter=/</uri> <uri>https://storage.swiftdrive.com/v1/CF_xer7_343/photos?delimiter=/</uri>
</screen> </screen>
<screen> <screen>
<computeroutput> <computeroutput>
HTTP/1.1 200 OK HTTP/1.1 200 OK
X-Container-Object-Count: 2 X-Container-Object-Count: 2
X-Container-Bytes-Used: 151868 X-Container-Bytes-Used: 151868

22
openstack-object-storage-dev/section_object-api-create-website.xml
View File

@ -57,41 +57,41 @@ format="SVG" scale="60"/>
pseudo-directories in your container, the index page displays pseudo-directories in your container, the index page displays
by default for each sub-directory. If your pseudo-directory by default for each sub-directory. If your pseudo-directory
does not have a file with the same name as your index file, does not have a file with the same name as your index file,
visits to the sub-directory return a 404 error. </para> visits to the sub-directory return a 404 error.</para>
<para>You also have the option of displaying a list of files in <para>You also have the option of displaying a list of files in
your pseudo-directory instead of a web page. You do this by your pseudo-directory instead of a web page. You do this by
setting the <code>X-Container-Meta-Web-Listings</code> header setting the <code>X-Container-Meta-Web-Listings</code> header
to <code>TRUE</code>. You may add style to your file listing to <code>TRUE</code>. You may add style to your file listing
by setting <code>X-Container-Meta-Web-Listings-CSS:</code> to by setting <code>X-Container-Meta-Web-Listings-CSS:</code> to
a style sheet (for example, <code>lists.css</code>). </para> a style sheet (for example, <code>lists.css</code>).</para>
<section xml:id="Examples_for_static_web-dle4025"> <section xml:id="Examples_for_static_web-dle4025">
<title>Static Web Middleware through swift</title> <title>Static Web Middleware through swift</title>
<example> <example>
<title>Make Container Publicly Readable</title> <title>Make Container Publicly Readable</title>
<para> Make the container publicly readable. Once the <para>Make the container publicly readable. Once the
container is publicly readable, you may access your container is publicly readable, you may access your
objects directly, but you will need to set the index objects directly, but you will need to set the index
file to browse the main site URL and its file to browse the main site URL and its
sub-directories. </para> sub-directories.</para>
<literallayout class="monospaced">swift post -r '.r:*' container</literallayout> <literallayout class="monospaced">swift post -r '.r:*' container</literallayout>
</example> </example>
<example> <example>
<title>Set Site Index File</title> <title>Set Site Index File</title>
<para>Set the index file. In this case, <para>Set the index file. In this case,
<code>index.html</code> is the default file <code>index.html</code> is the default file
displayed when the site displays. </para> displayed when the site displays.</para>
<literallayout class="monospaced">swift post -m 'web-index:index.html' container</literallayout> <literallayout class="monospaced">swift post -m 'web-index:index.html' container</literallayout>
</example> </example>
<example> <example>
<title>Enable File Listing</title> <title>Enable File Listing</title>
<para>Turn on file listing. If you do not set the index <para>Turn on file listing. If you do not set the index
file, list the objects in the container. Instructions file, list the objects in the container. Instructions
on styling the list with the CSS follow. </para> on styling the list with the CSS follow.</para>
<literallayout class="monospaced">swift post -m 'web-listings: true' container</literallayout> <literallayout class="monospaced">swift post -m 'web-listings: true' container</literallayout>
</example> </example>
<example> <example>
<title>Enable CSS for File Listing</title> <title>Enable CSS for File Listing</title>
<para>Style the file listing. </para> <para>Style the file listing.</para>
<literallayout class="monospaced"><xi:include href="samples/file-listings-css-set-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/file-listings-css-set-req.txt" parse="text"/></literallayout>
</example> </example>
</section> </section>
@ -100,8 +100,8 @@ format="SVG" scale="60"/>
<para>You can create and set custom error pages for visitors <para>You can create and set custom error pages for visitors
to your website; currently, only 401 (Unauthorized) and to your website; currently, only 401 (Unauthorized) and
404 (Not Found) errors are supported. To do this, set the 404 (Not Found) errors are supported. To do this, set the
metadata header, <code>X-Container-Meta-Web-Error</code>. </para> metadata header, <code>X-Container-Meta-Web-Error</code>.</para>
<para> Error pages are served with the &lt;status&gt; code <para>Error pages are served with the &lt;status&gt; code
prepended to the name of the error page you set. For prepended to the name of the error page you set. For
instance, if you set instance, if you set
<code>X-Container-Meta-Web-Error</code> to <code>X-Container-Meta-Web-Error</code> to
@ -110,9 +110,9 @@ format="SVG" scale="60"/>
will display <code>404error.html</code>. You must have will display <code>404error.html</code>. You must have
both of these pages created in your container when you set both of these pages created in your container when you set
the <code>X-Container-Meta-Web-Error</code> metadata, or the <code>X-Container-Meta-Web-Error</code> metadata, or
your site will display generic error pages. </para> your site will display generic error pages.</para>
<para>Set the <code>X-Container-Meta-Web-Error</code> metadata <para>Set the <code>X-Container-Meta-Web-Error</code> metadata
once for your entire static website. </para> once for your entire static website.</para>
<example> <example>
<title>Set Error Pages for Static Website Request</title> <title>Set Error Pages for Static Website Request</title>
<literallayout class="monospaced"><xi:include href="samples/error-page-set-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/error-page-set-req.txt" parse="text"/></literallayout>

36
openstack-object-storage-dev/section_object-api-storage-container-svc.xml
View File

@ -207,7 +207,7 @@ format="SVG" scale="60"/>
<literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-json-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-json-req.txt" parse="text"/></literallayout>
</example> </example>
<example> <example>
<title>Get Objects Details HTTP and JSON Response </title> <title>Get Objects Details HTTP and JSON Response</title>
<literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-json-resp.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-json-resp.txt" parse="text"/></literallayout>
<programlisting language="json"><xi:include href="samples/objects-get-details-resp.json" parse="text"/></programlisting> <programlisting language="json"><xi:include href="samples/objects-get-details-resp.json" parse="text"/></programlisting>
</example> </example>
@ -216,7 +216,7 @@ format="SVG" scale="60"/>
<literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-xml-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-xml-req.txt" parse="text"/></literallayout>
</example> </example>
<example> <example>
<title>Objects Details Request: XML </title> <title>Objects Details Request: XML</title>
<literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-xml-resp.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/objects-get-details-http-xml-resp.txt" parse="text"/></literallayout>
<programlisting language="xml"><xi:include href="samples/objects-get-details-resp.xml" parse="text"/></programlisting> <programlisting language="xml"><xi:include href="samples/objects-get-details-resp.xml" parse="text"/></programlisting>
</example> </example>
@ -263,7 +263,7 @@ reddelicious</literallayout>
list.</para> list.</para>
<para>By using <code>end_marker</code> we can limit <para>By using <code>end_marker</code> we can limit
the result set to object names less than the given the result set to object names less than the given
value. </para> value.</para>
<literallayout class="monospaced"><xi:include href="samples/objects-list-end-marker-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/objects-list-end-marker-req.txt" parse="text"/></literallayout>
</example> </example>
</section> </section>
@ -294,11 +294,11 @@ reddelicious</literallayout>
Request</title> Request</title>
<para>To display a list of all the objects in the <para>To display a list of all the objects in the
storage container, use &GET; without a storage container, use &GET; without a
<code>delimiter</code> or <code>prefix</code>. </para> <code>delimiter</code> or <code>prefix</code>.</para>
<literallayout class="monospaced">GET /v1/AccountString/backups</literallayout> <literallayout class="monospaced">GET /v1/AccountString/backups</literallayout>
<para>The system returns status code 2xx (between 200 <para>The system returns status code 2xx (between 200
and 299, inclusive) and the requested list of the and 299, inclusive) and the requested list of the
objects. </para> objects.</para>
<literallayout class="monospaced">photos/animals/cats/persian.jpg <literallayout class="monospaced">photos/animals/cats/persian.jpg
photos/animals/cats/siamese.jpg photos/animals/cats/siamese.jpg
photos/animals/dogs/corgi.jpg photos/animals/dogs/corgi.jpg
@ -313,7 +313,7 @@ photos/plants/rose.jpg</literallayout>
results. Any character may be used as a delimiter. results. Any character may be used as a delimiter.
However, to use <code>delimiter</code> with However, to use <code>delimiter</code> with
pseudo-directories, use the parameter slash pseudo-directories, use the parameter slash
(<literal>/</literal>). </para> (<literal>/</literal>).</para>
<literallayout class="monospaced">GET /v1/AccountString/backups?delimiter=/</literallayout> <literallayout class="monospaced">GET /v1/AccountString/backups?delimiter=/</literallayout>
<para>The system returns status code 2xx (between 200 <para>The system returns status code 2xx (between 200
and 299, inclusive) and the requested matching and 299, inclusive) and the requested matching
@ -324,17 +324,17 @@ photos/plants/rose.jpg</literallayout>
They have a content-type of They have a content-type of
<literal>application/directory</literal> and are in <literal>application/directory</literal> and are in
the <literal>subdir</literal> section of json and xml the <literal>subdir</literal> section of json and xml
results. </para> results.</para>
<literallayout class="monospaced">photos/</literallayout> <literallayout class="monospaced">photos/</literallayout>
<para>Use the <code>prefix</code> parameter with the <para>Use the <code>prefix</code> parameter with the
<code>delimiter</code> parameter to view the <code>delimiter</code> parameter to view the
objects inside a pseudo-directory, including objects inside a pseudo-directory, including
further nested pseudo-directories. </para> further nested pseudo-directories.</para>
<literallayout class="monospaced">GET /v1/AccountString/backups?prefix=photos/&#38;delimiter=/</literallayout> <literallayout class="monospaced">GET /v1/AccountString/backups?prefix=photos/&#38;delimiter=/</literallayout>
<para>The system returns status code 2xx (between 200 <para>The system returns status code 2xx (between 200
and 299, inclusive) and the objects and and 299, inclusive) and the objects and
pseudo-directories within the top level pseudo-directories within the top level
pseudo-directory. </para> pseudo-directory.</para>
<literallayout class="monospaced">photos/animals/ <literallayout class="monospaced">photos/animals/
photos/me.jpg photos/me.jpg
photos/plants/ </literallayout> photos/plants/ </literallayout>
@ -346,7 +346,7 @@ photos/plants/ </literallayout>
called <code>dogs</code> within the called <code>dogs</code> within the
pseudo-directory <code>animals</code>. In order to pseudo-directory <code>animals</code>. In order to
navigate directly to the files contained within navigate directly to the files contained within
<code>dogs</code>, enter the below command. </para> <code>dogs</code>, enter the below command.</para>
<literallayout class="monospaced">GET /v1/AccountString/backups?prefix=photos/animals/dogs/&#38;delimiter=/ </literallayout> <literallayout class="monospaced">GET /v1/AccountString/backups?prefix=photos/animals/dogs/&#38;delimiter=/ </literallayout>
<para>The system returns status code 2xx (between 200 <para>The system returns status code 2xx (between 200
and 299, inclusive) and the objects and and 299, inclusive) and the objects and
@ -368,9 +368,9 @@ photos/animals/dogs/terrier.jpg</literallayout>
<para>Containers can be assigned custom metadata by including <para>Containers can be assigned custom metadata by including
additional HTTP headers on the &PUT; request. The custom additional HTTP headers on the &PUT; request. The custom
metadata is assigned to a container via HTTP headers metadata is assigned to a container via HTTP headers
identified with the <code>X-Container-Meta-</code> prefix. </para> identified with the <code>X-Container-Meta-</code> prefix.</para>
<example> <example>
<title>Create Container HTTP Request </title> <title>Create Container HTTP Request</title>
<literallayout class="monospaced"><xi:include href="samples/container-create-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/container-create-req.txt" parse="text"/></literallayout>
</example> </example>
<para>No content is returned. A status code of 201 (Created) <para>No content is returned. A status code of 201 (Created)
@ -417,7 +417,7 @@ photos/animals/dogs/terrier.jpg</literallayout>
<title>Delete Container</title> <title>Delete Container</title>
<para>&DELETE; operations against a storage container <para>&DELETE; operations against a storage container
permanently remove it. The container must be empty before permanently remove it. The container must be empty before
it can be deleted. </para> it can be deleted.</para>
<para>A &HEAD; request against the container can be used to <para>A &HEAD; request against the container can be used to
determine if it contains any objects.</para> determine if it contains any objects.</para>
<example> <example>
@ -463,10 +463,10 @@ photos/animals/dogs/terrier.jpg</literallayout>
<title>Create or Update Container Metadata</title> <title>Create or Update Container Metadata</title>
<para>You may create any custom or arbitrary metadata headers <para>You may create any custom or arbitrary metadata headers
as you find useful. They must, however, take the format as you find useful. They must, however, take the format
<code>X-Container-Meta-</code>. </para> <code>X-Container-Meta-</code>.</para>
<para>To create or update the arbitrary container metadata, <para>To create or update the arbitrary container metadata,
use the &POST; query. Subsequent requests of the same use the &POST; query. Subsequent requests of the same
key/value pair overwrites the previous value. </para> key/value pair overwrites the previous value.</para>
<example> <example>
<title>Update Container Metadata HTTP Request</title> <title>Update Container Metadata HTTP Request</title>
<literallayout class="monospaced"><xi:include href="samples/container-update-metadata-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/container-update-metadata-req.txt" parse="text"/></literallayout>
@ -474,7 +474,7 @@ photos/animals/dogs/terrier.jpg</literallayout>
<para>No response body is returned. A status code of 2xx <para>No response body is returned. A status code of 2xx
(between 200 and 299, inclusive) indicates success; status 404 (between 200 and 299, inclusive) indicates success; status 404
(Not Found) is returned when the requested container does not (Not Found) is returned when the requested container does not
exist. </para> exist.</para>
<example> <example>
<title>Update Container Metadata HTTP Response</title> <title>Update Container Metadata HTTP Response</title>
<literallayout class="monospaced"><xi:include href="samples/container-update-metadata-resp.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/container-update-metadata-resp.txt" parse="text"/></literallayout>
@ -498,7 +498,7 @@ photos/animals/dogs/terrier.jpg</literallayout>
<title>Delete Container Metadata</title> <title>Delete Container Metadata</title>
<para>To delete a metadata header send an empty value for that <para>To delete a metadata header send an empty value for that
particular header, such as particular header, such as
<code>X-Container-Meta-Book:</code>. </para> <code>X-Container-Meta-Book:</code>.</para>
<para>If the tool you're using to communicate with Object <para>If the tool you're using to communicate with Object
Storage doesn't support sending empty headers (older Storage doesn't support sending empty headers (older
versions of curl) send the header versions of curl) send the header
@ -512,7 +512,7 @@ photos/animals/dogs/terrier.jpg</literallayout>
<title>Delete Container Metadata HTTP Request</title> <title>Delete Container Metadata HTTP Request</title>
<literallayout class="monospaced"><xi:include href="samples/container-delete-metadata-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/container-delete-metadata-req.txt" parse="text"/></literallayout>
<para>No response body is returned. A status code of 2xx <para>No response body is returned. A status code of 2xx
(between 200 and 299, inclusive) indicates success. </para> (between 200 and 299, inclusive) indicates success.</para>
</example> </example>
</section> </section>
</section> </section>

6
openstack-object-storage-dev/section_object-api-storage-object-svc.xml
View File

@ -458,7 +458,7 @@
header in a &PUT; operation. This creates a header in a &PUT; operation. This creates a
new manifest object that shares the same set new manifest object that shares the same set
of segment objects as the original manifest of segment objects as the original manifest
object. </td> object.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
@ -845,10 +845,10 @@
remove an object and you have five total versions of it, remove an object and you have five total versions of it,
you must &DELETE; it five times.</para> you must &DELETE; it five times.</para>
<note> <note>
<para> A large-object manifest file cannot be versioned, <para>A large-object manifest file cannot be versioned,
but it may point to versioned segments.</para> but it may point to versioned segments.</para>
</note> </note>
<para> To turn off Object Versioning on your current version <para>To turn off Object Versioning on your current version
container, remove its <code>X-Versions-Location</code> container, remove its <code>X-Versions-Location</code>
metadata by sending an empty key value.</para> metadata by sending an empty key value.</para>
<example> <example>

12
openstack-object-storage-dev/section_object-api-storage_account_svc.xml
View File

@ -163,7 +163,7 @@ format="SVG" scale="60"/>
<code>format=json</code> argument is appended to <code>format=json</code> argument is appended to
the storage account URL, the service serves extended the storage account URL, the service serves extended
container information serialized in the chosen format. container information serialized in the chosen format.
The sample responses are formatted for readability. </para> The sample responses are formatted for readability.</para>
<para>The following HTTP request asks for a JSON response, <para>The following HTTP request asks for a JSON response,
so the response returns an HTTP header and a JSON so the response returns an HTTP header and a JSON
response.</para> response.</para>
@ -238,7 +238,7 @@ oranges</literallayout>
list.</para> list.</para>
<para>By using <code>end_marker</code> we can limit <para>By using <code>end_marker</code> we can limit
the result set to container names less than the the result set to container names less than the
given value. </para> given value.</para>
<literallayout class="monospaced"><xi:include href="samples/large-container-list-filter-end-marker-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/large-container-list-filter-end-marker-req.txt" parse="text"/></literallayout>
<literallayout class="monospaced">apples <literallayout class="monospaced">apples
bananas bananas
@ -276,16 +276,16 @@ kiwis</literallayout>
<title>Create or Update Account Metadata</title> <title>Create or Update Account Metadata</title>
<para>You can associate custom metadata headers with the <para>You can associate custom metadata headers with the
account level URI. These headers must take the format account level URI. These headers must take the format
<code>X-Account-Meta-*</code>. </para> <code>X-Account-Meta-*</code>.</para>
<para>To create or update an account metadata header use the <para>To create or update an account metadata header use the
&POST; query. Subsequent requests for the same key/value &POST; query. Subsequent requests for the same key/value
pair overwrite the previous value. </para> pair overwrite the previous value.</para>
<example> <example>
<title>Update Account Metadata HTTP Request</title> <title>Update Account Metadata HTTP Request</title>
<literallayout class="monospaced"><xi:include href="samples/account-update-metadata-req.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/account-update-metadata-req.txt" parse="text"/></literallayout>
</example> </example>
<para>No response body is returned. A status code of 2xx <para>No response body is returned. A status code of 2xx
(between 200 and 299, inclusive) indicates success. </para> (between 200 and 299, inclusive) indicates success.</para>
<example> <example>
<title>Update Account Metadata HTTP Response</title> <title>Update Account Metadata HTTP Response</title>
<literallayout class="monospaced"><xi:include href="samples/account-update-metadata-resp.txt" parse="text"/></literallayout> <literallayout class="monospaced"><xi:include href="samples/account-update-metadata-resp.txt" parse="text"/></literallayout>
@ -306,7 +306,7 @@ kiwis</literallayout>
<title>Delete Account Metadata</title> <title>Delete Account Metadata</title>
<para>To delete a metadata header, send an empty value for <para>To delete a metadata header, send an empty value for
that particular header, such as for the that particular header, such as for the
<code>X-Account-Meta-Book</code> header. </para> <code>X-Account-Meta-Book</code> header.</para>
<para>If the tool you use to communicate with Object Storage, <para>If the tool you use to communicate with Object Storage,
such as older versions of cURL, does not support empty such as older versions of cURL, does not support empty
headers, send the headers, send the