Object Storage API Ref - file name clean up and spellcheck
Change-Id: I5a0343c23263f018d9138b5338b10b4f4fe1ae55 author: diane fleming
This commit is contained in:
Diane Fleming
parent
5d5d48db44
commit
41aef0c7a6
|
|
@ -63,7 +63,7 @@
|
|||
<abstract>
|
||||
<para>This reference is for software developers who develop
|
||||
applications by using the OpenStack™ Object Storage
|
||||
Application Programming Interface (API) v1. </para>
|
||||
Application Programming Interface (API) v1.</para>
|
||||
</abstract>
|
||||
<revhistory>
|
||||
<revision>
|
||||
|
|
@ -71,7 +71,7 @@
|
|||
<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 +81,7 @@
|
|||
<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>
|
||||
|
|
@ -91,7 +91,7 @@
|
|||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Updates for static large object support. </para>
|
||||
<para>Updates for static large object support.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -102,7 +102,7 @@
|
|||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Moved code samples into separate files for content
|
||||
sharing. </para>
|
||||
sharing.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -113,7 +113,7 @@
|
|||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Fixed bug 1049362 - Adds back metadata deletion
|
||||
information. </para>
|
||||
information.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -124,7 +124,7 @@
|
|||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Fixed bugs 1009706 - Added Object Versioning and
|
||||
Static Web. </para>
|
||||
Static Web.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -136,7 +136,7 @@
|
|||
<listitem>
|
||||
<para>Fixed bugs 890435 and 907563 - Add/Update
|
||||
Container Metadata and Expiring Objects. Changed to
|
||||
Maven 1.0.10. </para>
|
||||
Maven 1.0.10.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -147,7 +147,7 @@
|
|||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Revised to change first to last in the first range
|
||||
example for fetching a portion of an object. </para>
|
||||
example for fetching a portion of an object.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -162,7 +162,7 @@
|
|||
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>
|
||||
but it's pointed out in the documentation.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -174,8 +174,7 @@
|
|||
<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>
|
||||
|
|
@ -185,9 +184,9 @@
|
|||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para> Expanded authentication information for UK
|
||||
<para>Expanded authentication information for UK
|
||||
release. Added "delimiter" as a Query Parameter and
|
||||
server-side object copy example. </para>
|
||||
server-side object copy example.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
|
|
@ -197,18 +196,16 @@
|
|||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Initial Release. </para>
|
||||
<para>Initial Release.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
</revision>
|
||||
</revhistory>
|
||||
|
||||
</info>
|
||||
|
||||
<!-- Chapters are referred from the book file through these include statements. You can add additional chapters using these types of statements. -->
|
||||
<xi:include href="object-api-overview.xml"/>
|
||||
<xi:include href="object-api-general.xml"/>
|
||||
<xi:include href="object-api-storage-services.xml"/>
|
||||
<xi:include href="object-api-troubleshooting-examples.xml"/>
|
||||
<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"/>
|
||||
</book>
|
||||
|
|
@ -25,7 +25,7 @@ format="SVG" scale="60"/>
|
|||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
]>
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
<preface 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="ch_object-storage-dev-overview">
|
||||
|
|
@ -81,4 +81,5 @@ format="SVG" scale="60"/>
|
|||
its own documentation in its native format. For example,
|
||||
the Java API includes Javadoc documentation.</para>
|
||||
</section>
|
||||
</chapter>
|
||||
<xi:include href="section_object-api-dochistory.xml"/>
|
||||
</preface>
|
||||
|
|
@ -74,8 +74,8 @@ format="SVG" scale="60"/>
|
|||
you can perform on objects. </para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<xi:include href="object-api-storage_account_svc.xml"/>
|
||||
<xi:include href="object-api-storage-container-svc.xml"/>
|
||||
<xi:include href="object-api-create-website.xml"/>
|
||||
<xi:include href="object-api-storage-object-svc.xml"/>
|
||||
<xi:include href="section_object-api-storage_account_svc.xml"/>
|
||||
<xi:include href="section_object-api-storage-container-svc.xml"/>
|
||||
<xi:include href="section_object-api-create-website.xml"/>
|
||||
<xi:include href="section_object-api-storage-object-svc.xml"/>
|
||||
</chapter>
|
||||
|
|
@ -8,103 +8,69 @@
|
|||
<artifactId>openstack-object-api-guide</artifactId>
|
||||
<version>1.0.0</version>
|
||||
<packaging>jar</packaging>
|
||||
<name>OpenStack Specifications</name>
|
||||
<name>OpenStack API References</name>
|
||||
<properties>
|
||||
<!-- This is set by Jenkins according to the branch. -->
|
||||
<release.path.name>local</release.path.name>
|
||||
<comments.enabled>1</comments.enabled>
|
||||
</properties>
|
||||
<!-- ################################################ -->
|
||||
<!-- USE "mvn clean generate-sources" to run this POM -->
|
||||
<!-- ################################################ -->
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
|
||||
<plugin>
|
||||
<groupId>com.rackspace.cloud.api</groupId>
|
||||
<artifactId>clouddocs-maven-plugin</artifactId>
|
||||
|
||||
<version>1.8.0</version>
|
||||
|
||||
<version>1.11.0</version>
|
||||
<executions>
|
||||
<!-- Configuration for OpenStack End User Guide -->
|
||||
<execution>
|
||||
<id>generate-webhelp</id>
|
||||
<id>os-objectstorage</id>
|
||||
<goals>
|
||||
<goal>generate-webhelp</goal>
|
||||
</goals>
|
||||
<phase>generate-sources</phase>
|
||||
<configuration>
|
||||
<!-- These parameters only apply to webhelp -->
|
||||
<enableDisqus>1</enableDisqus>
|
||||
<disqusShortname>os-object-api</disqusShortname>
|
||||
<enableGoogleAnalytics>1</enableGoogleAnalytics>
|
||||
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
|
||||
<generateToc> appendix toc,title
|
||||
article/appendix nop
|
||||
article toc,title
|
||||
book toc,title,figure,table,example,equation
|
||||
chapter toc
|
||||
section toc
|
||||
part toc,title
|
||||
preface toc
|
||||
qandadiv toc
|
||||
qandaset toc
|
||||
<includes> bk_os-objectstorage-devguide.xml</includes>
|
||||
<generateToc>
|
||||
appendix toc
|
||||
article/appendix nop
|
||||
article toc,title
|
||||
book toc,title,figure,equation
|
||||
chapter toc
|
||||
section toc
|
||||
part toc,title
|
||||
preface toc
|
||||
qandadiv toc
|
||||
qandaset toc
|
||||
reference toc,title
|
||||
set toc,title
|
||||
</generateToc>
|
||||
|
||||
<tocDepthSection>1</tocDepthSection>
|
||||
set toc,title </generateToc>
|
||||
<targetDirectory>target/docbkx/webhelp/api/openstack-object-storage</targetDirectory>
|
||||
<webhelpDirname>1.0</webhelpDirname>
|
||||
<pdfFilenameBase>os-objectstorage-devguide-1.0</pdfFilenameBase>
|
||||
<postProcess>
|
||||
<mkdir
|
||||
dir="${basedir}/target/docbkx/webhelp/api/openstack-object-storage/1.0/"/>
|
||||
|
||||
<!-- Copies schema to a folder and styling for the schemas so a browser can display them -->
|
||||
|
||||
<copy
|
||||
todir="${basedir}/target/docbkx/webhelp/api/openstack-object-storage/1.0/samples">
|
||||
<fileset
|
||||
dir="${basedir}/src/docbkx/samples">
|
||||
<include name="**/*.*"/>
|
||||
</fileset>
|
||||
</copy>
|
||||
|
||||
<!-- <copy
|
||||
todir="${basedir}/target/docbkx/webhelp/api/openstack-compute/2/">
|
||||
<fileset
|
||||
dir="${basedir}/target/docbkx/webhelp/os-compute-devguide/">
|
||||
<include name="**/*" />
|
||||
</fileset>
|
||||
</copy>-->
|
||||
|
||||
<!-- Copies wadl to a folder -->
|
||||
<copy
|
||||
todir="${basedir}/target/docbkx/webhelp/api/openstack-object-storage/1.0/">
|
||||
<fileset dir="${basedir}/src/">
|
||||
<include name="**/*.wadl"/>
|
||||
</fileset>
|
||||
</copy>
|
||||
<!--Moves PDFs to the needed placement -->
|
||||
<!--<move failonerror="false"
|
||||
file="${basedir}/target/docbkx/pdf/os-compute-devguide.pdf"
|
||||
tofile="${basedir}/target/docbkx/webhelp/api/openstack-compute/2/os-compute-devguide-2.pdf"/>
|
||||
-->
|
||||
|
||||
<!--Deletes leftover uneeded directories -->
|
||||
|
||||
<delete
|
||||
dir="${basedir}/target/docbkx/webhelp/os-object-storage-devguide"/>
|
||||
</postProcess>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<!-- These parameters apply to pdf and webhelp -->
|
||||
|
||||
<chapterAutolabel>1</chapterAutolabel>
|
||||
<appendixAutolabel>1</appendixAutolabel>
|
||||
<sectionAutolabel>0</sectionAutolabel>
|
||||
<tocSectionDepth>1</tocSectionDepth>
|
||||
<formalProcedures>0</formalProcedures>
|
||||
<highlightSource>false</highlightSource>
|
||||
<xincludeSupported>true</xincludeSupported>
|
||||
<sourceDirectory>src/docbkx</sourceDirectory>
|
||||
<includes>
|
||||
os-objectstorage-devguide.xml
|
||||
</includes>
|
||||
<profileSecurity>reviewer</profileSecurity>
|
||||
<showXslMessages>true</showXslMessages>
|
||||
<sourceDirectory>.</sourceDirectory>
|
||||
<feedbackEmail>diane.fleming@rackspace.com</feedbackEmail>
|
||||
<security>external</security>
|
||||
<branding>openstack</branding>
|
||||
<enableDisqus>${comments.enabled}</enableDisqus>
|
||||
<disqusShortname>os-object-api</disqusShortname>
|
||||
<enableGoogleAnalytics>1</enableGoogleAnalytics>
|
||||
<googleAnalyticsId>UA-17511903-1</googleAnalyticsId>
|
||||
<suppressFooterNavigation>0</suppressFooterNavigation>
|
||||
</configuration>
|
||||
</plugin>
|
||||
</plugins>
|
||||
|
|
|
|||
|
|
@ -30,12 +30,7 @@ format="SVG" scale="60"/>
|
|||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
|
||||
xml:id="doc_history">
|
||||
<title>Document Change History</title>
|
||||
<para>This version of the guide was forked from the <citetitle>Rackspace Cloud Files Developer
|
||||
Guide</citetitle>.
|
||||
</para>
|
||||
<!-- *** -->
|
||||
|
||||
<?rax revhistory?>
|
||||
|
||||
<!-- *** -->
|
||||
<para>This version of the document replaces and obsoletes
|
||||
all previous versions. The following table describes the latest changes:</para>
|
||||
<?rax revhistory?>
|
||||
</section>
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE section [
|
||||
<!-- Some useful entities borrowed from HTML -->
|
||||
<!ENTITY ndash "–">
|
||||
<!ENTITY mdash "—">
|
||||
<!ENTITY hellip "…">
|
||||
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
|
||||
<!ENTITY CHECK '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
||||
<imageobject>
|
||||
<imagedata fileref="img/Check_mark_23x20_02.svg"
|
||||
format="SVG" scale="60"/>
|
||||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
|
||||
<!ENTITY ARROW '<inlinemediaobject xmlns="http://docbook.org/ns/docbook">
|
||||
<imageobject>
|
||||
<imagedata fileref="img/Arrow_east.svg"
|
||||
format="SVG" scale="60"/>
|
||||
</imageobject>
|
||||
</inlinemediaobject>'>
|
||||
]>
|
||||
<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="additional-resources-object-devguide">
|
||||
<title>Additional Resources</title>
|
||||
<para>You can download the most current version of this document from the OpenStack Docs
|
||||
website at <link
|
||||
xlink:href="http://docs.openstack.org">
|
||||
http://docs.openstack.org</link>. </para>
|
||||
<para>For more information about the Rackspace implementation of
|
||||
the OpenStack Object Storage service, see: <link
|
||||
xlink:href="www.rackspacecloud.com/cloud_hosting_products/files"
|
||||
>
|
||||
http://www.rackspacecloud.com/cloud_hosting_products/files</link>.
|
||||
Related documents are available at the same site, as are links
|
||||
to the Rackspace official support channels, including
|
||||
knowledge base articles, forums, phone, chat, and email. </para>
|
||||
|
||||
</section>
|
||||
Loading…
Reference in New Issue