From 840ec25143941b8ff8748bee1d5eb77bdf2e68ce Mon Sep 17 00:00:00 2001
From: Diane Fleming <diane.fleming@rackspace.com>
Date: Mon, 23 Dec 2013 14:30:41 -0600
Subject: [PATCH] Document range header for objects

Partial-Bug: #1263759

Change-Id: I3d8c4e3f2995859edced6f519da46a811b0d580a
author: diane fleming
---
 .../section_object-api-storage-object-svc.xml | 53 ++++++++++++-------
 1 file changed, 35 insertions(+), 18 deletions(-)

diff --git a/openstack-object-storage-dev/section_object-api-storage-object-svc.xml b/openstack-object-storage-dev/section_object-api-storage-object-svc.xml
index 7c70766..fe066d3 100644
--- a/openstack-object-storage-dev/section_object-api-storage-object-svc.xml
+++ b/openstack-object-storage-dev/section_object-api-storage-object-svc.xml
@@ -80,15 +80,15 @@
             <term><code>X-Newest</code></term>
             <listitem>
                 <para>Set the optional <code>X-newest</code> header to
-                    <code>True</code> in HEAD and GET requests to have
-                    Object Storage return the latest version of the object.
-                    If set to <code>True</code>, Object Storage queries all
-                    replicas to return the most recent one. Without this header,
-                    Object Storage responds faster after it finds one valid replica.
-                    Because setting this header to <code>True</code> is more
-                    expensive for the back end, use it only when it is
-                    absolutely needed.
-                </para>
+                        <code>True</code> in HEAD and GET requests to
+                    have Object Storage return the latest version of
+                    the object. If set to <code>True</code>, Object
+                    Storage queries all replicas to return the most
+                    recent one. Without this header, Object Storage
+                    responds faster after it finds one valid replica.
+                    Because setting this header to <code>True</code>
+                    is more expensive for the back end, use it only
+                    when it is absolutely needed.</para>
             </listitem>
         </varlistentry>
     </variablelist>
@@ -139,8 +139,8 @@
         <para>The following forms of the header specify the following
             ranges of data:</para>
         <informaltable rules="all">
-            <col width="50%"/>
-            <col width="50%"/>
+            <col width="40%"/>
+            <col width="60%"/>
             <thead>
                 <tr>
                     <th>Header</th>
@@ -151,7 +151,24 @@
                 <tr>
                     <td>
                         <para><code>Range: bytes=-5</code></para></td>
-                    <td><para>The last 5 bytes.</para>
+                    <td><para>The last five bytes.</para>
+                    </td>
+                </tr>
+                <tr>
+                    <td><para><code>Range:
+                        bytes=10-14</code></para></td>
+                    <td>The five bytes of data after a 10-byte
+                        offset.</td>
+                </tr>
+                <tr>
+                    <td><para><code>Range:
+                            bytes=10-14,-5</code></para></td>
+                    <td><para>A multi-part response that contains the five bytes of data after
+                            a 10-byte offset and the last five
+                            bytes.</para>
+                        <para>The <code>Content-Type</code> of the
+                            response is then
+                                <code>multipart/byteranges</code>.</para>
                     </td>
                 </tr>
                 <tr>
@@ -164,21 +181,21 @@
                     <td>
                         <para><code>Range:
                         bytes=2-2</code></para></td>
-                    <td><para>Byte 2, the third byte of the
-                            data.</para>
+                    <td><para>Byte 2, which is the third byte of the data.</para>
                     </td>
                 </tr>
                 <tr>
                     <td>
                         <para><code>Range: bytes=6-</code></para></td>
-                    <td><para>Byte 6 byte and after.</para>
+                    <td><para>Byte 6 and after.</para>
                     </td>
                 </tr>
                 <tr>
                     <td>
                         <para><code>Range:
                         bytes=1-3,2-5</code></para></td>
-                    <td><para>Bytes 1 to 3 inclusive, and bytes 2 to 5
+                    <td><para>A multi-part response that contains
+                            bytes 1 to 3 inclusive, and bytes 2 to 5
                             inclusive.</para>
                         <para>The <code>Content-Type</code> of the
                             response is then
@@ -334,8 +351,8 @@
                 object as the source, the new object is a "normal"
                 object (not segmented). If the total size of the
                 source segment objects exceeds 5 GB, the &COPY;
-                operation fails. However, as explained later, you
-                can make a duplicate of the manifest object. This new
+                operation fails. However, as explained later, you can
+                make a duplicate of the manifest object. This new
                 object can be larger than 5 GB.</para>
         </note>
         <para>The manifest object type are:</para>