openstack-attic/object-api
Code Issues Proposed changes

Editorial changes - object-api dev guide

Browse Source 
backport: havana

Change-Id: Ic9a831568002b6ab02d7506693c0ff36852795f6
author: diane fleming
This commit is contained in:
Diane Fleming 2013-10-16 15:23:40 -05:00
parent 5885d6f732
commit a0431b8570
4 changed files with 51 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
openstack-object-storage-dev/bk_os-objectstorage-devguide.xml
View File

@ -66,12 +66,24 @@
Application Programming Interface (API) v1.</para>
</abstract>
<revhistory>
<revision>
<date>2013-10-16</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Updated the description of the delete account
metadata method.</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
<revision>
<date>2013-09-28</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Clarify UTF-8 and URL-encoding of container and object names in headers.</para>
<para>Clarify UTF-8 and URL-encoding of container and
object names in headers.</para>
</listitem>
</itemizedlist>
</revdescription>
@ -81,7 +93,8 @@
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Corrected delete container to be delete object.</para>
<para>Corrected delete container to be delete
object.</para>
</listitem>
</itemizedlist>
</revdescription>
@ -160,9 +173,8 @@
<para>Revised for OpenStack Object Storage use by
removing CDN references, Rackspace Cloud references,
and revised account examples and URLs for generic
implementations. It's not a changed requirement that
Container and Object names are required to be UTF-8,
but it's pointed out in the documentation.</para>
implementations. Clarified that container and object
names must be UTF-8 encoded.</para>
</listitem>
</itemizedlist>
</revdescription>
@ -174,7 +186,8 @@
<listitem>
<para>Removed references to ACL (Access Control List).
Fixed error in examples referring to X-Auth-Key where
it should be X-Auth-Token. Added section numbers.</para>
it should be X-Auth-Token. Added section
numbers.</para>
</listitem>
</itemizedlist>
</revdescription>
@ -192,7 +205,7 @@
</revdescription>
</revision>
<revision>
<date>2008-05-5</date>
<date>2008-05-05</date>
<revdescription>
<itemizedlist spacing="compact">
<listitem>
@ -207,5 +220,5 @@
<xi:include href="ch_object-api-overview.xml"/>
<xi:include href="ch_object-api-general.xml"/>
<xi:include href="ch_object-api-storage-services.xml"/>
<xi:include href="ch_object-api-troubleshooting-examples.xml"/>
<xi:include href="ch_object-api-troubleshooting-examples.xml"/>
</book>

15
openstack-object-storage-dev/ch_object-api-storage-services.xml
View File

@ -49,29 +49,30 @@ format="SVG" scale="60"/>
character restrictions.</para>
</listitem>
<listitem>
<para>Object and container names must be UTF-8 encoded and then URL-encoded to interact with
the ReST API.</para>
<para>Object and container names must be UTF-8 encoded and then
URL-encoded to interact with the ReST API.</para>
</listitem>
</itemizedlist>
<para><!--<info>Added paragraph to forecast info structure -\- dsh -2012-03-09 </info>-->The
following sections describe the actions that you can perform in
the storage system. </para>
the storage system.</para>
<itemizedlist>
<listitem>
<para><xref linkend="storage-account-services"/>. Actions that
you can perform at the account level of the storage system. </para>
you can perform at the account level of the storage system.
</para>
</listitem>
<listitem>
<para><xref linkend="storage-container-services"/>. Actions that
you can perform on containers. </para>
you can perform on containers.</para>
</listitem>
<listitem>
<para><xref linkend="Create_Static_Website-dle4000"/>. How to
use your swift account to create a static website. </para>
use your swift account to create a static website.</para>
</listitem>
<listitem>
<para><xref linkend="storage-object-services"/>. Actions that
you can perform on objects. </para>
you can perform on objects.</para>
</listitem>
</itemizedlist>
<xi:include href="section_object-api-storage_account_svc.xml"/>

5
openstack-object-storage-dev/pom.xml
View File

@ -1,9 +1,7 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.openstack.docs</groupId>
<artifactId>openstack-object-api-guide</artifactId>
<version>1.0.0</version>
@ -53,7 +51,6 @@
</execution>
</executions>
<configuration>
<chapterAutolabel>1</chapterAutolabel>
<appendixAutolabel>1</appendixAutolabel>
<sectionAutolabel>0</sectionAutolabel>

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

@ -133,8 +133,8 @@ format="SVG" scale="60"/>
<literallayout class="monospaced"><xi:include href="samples/containers-list-req.txt" parse="text"/></literallayout>
</example>
<para>A list of containers is returned in the response body,
one container per line. The HTTP response's status code will
be 2xx (between 200 and 299, inclusive).</para>
one container per line. The HTTP response's status code
will be 2xx (between 200 and 299, inclusive).</para>
<example>
<title>List Containers HTTP Response</title>
<literallayout class="monospaced"><xi:include href="samples/containers-list-resp.txt" parse="text"/></literallayout>
@ -246,8 +246,9 @@ kiwis</literallayout>
<literallayout class="monospaced"><xi:include href="samples/account-get-metadata-req.txt" parse="text"/></literallayout>
</example>
<para>The HTTP return code will be 2xx (between 200 and 299,
inclusive) if the request succeeds. A 401 (Unauthorized) will
be returned for an invalid account or access key.</para>
inclusive) if the request succeeds. A 401 (Unauthorized)
will be returned for an invalid account or access
key.</para>
<example>
<title>Get Account Metadata HTTP Response</title>
<literallayout class="monospaced"><xi:include href="samples/account-get-metadata-resp.txt" parse="text"/></literallayout>
@ -255,17 +256,17 @@ kiwis</literallayout>
</section>
<section xml:id="create-update-account-metadata">
<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
<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
pair overwrite the previous value. </para>
<example>
<title>Update Account Metadata HTTP Request</title>
<literallayout class="monospaced"><xi:include href="samples/account-update-metadata-req.txt" parse="text"/></literallayout>
</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>
<example>
<title>Update Account Metadata HTTP Response</title>
@ -285,21 +286,22 @@ kiwis</literallayout>
</section>
<section xml:id="delete-account-metadata">
<title>Delete Account Metadata</title>
<para>To delete a metadata header send an empty value for that
particular header, such as
<code>X-Account-Meta-Book</code>. </para>
<para>If the tool you're using to communicate with Swift
doesn't support sending empty headers (such as older
versions of cURL) send the header
"X-Remove-Account-Meta-<replaceable>name</replaceable>:
<replaceable>arbitrary value</replaceable>", such as
<code>X-Remove-Account-Meta-Book: x</code>. The
<emphasis>value</emphasis> is ignored.</para>
<para>To delete a metadata header, send an empty value for
that particular header, such as for the
<code>X-Account-Meta-Book</code> header. </para>
<para>If the tool you use to communicate with Object Storage,
such as older versions of cURL, does not support empty
headers, send the
<literal>X-Remove-Account-Meta-</literal><replaceable>name</replaceable><literal>:</literal>
<replaceable>arbitrary value</replaceable> header. For
example, <code>X-Remove-Account-Meta-Book: x</code>. The
<replaceable>arbitrary value</replaceable> is
ignored.</para>
<example>
<title>Delete Account Metadata HTTP Request</title>
<literallayout class="monospaced"><xi:include href="samples/account-delete-metadata-req.txt" parse="text"/></literallayout>
<para> No response body is returned. A status code of 2xx
(between 200 and 299, inclusive) indicates success.</para>
<para>No response body is returned. A status code from 200
to 299 indicates success.</para>
</example>
</section>
</section>