openstack/api-site
Code Issues Proposed changes

Merge "Adds Object API to API Quick Start"

Browse Source
This commit is contained in:
Jenkins 2011-11-09 14:44:44 +00:00 committed by Gerrit Code Review
commit ad7030f04c
1 changed files with 51 additions and 0 deletions

51
doc/src/docbkx/api-quick-start/src/docbkx/api-examples.xml

@ -181,4 +181,55 @@
<section xml:id="Identity-API-Examples"><title>Identity API Examples</title>
<para>POST /v2.0/tokens</para>
<para>GET /v2.0/tenants</para></section>
<section xml:id="Object-API-Examples"><title>Object API Examples</title>
<variablelist>
<title>Query Parameters</title>
<varlistentry>
<term><code>limit</code></term>
<listitem>
<para>For an integer value <inlineequation>
<mathphrase><emphasis>n</emphasis></mathphrase>
</inlineequation>, limits the number of results to at most <inlineequation>
<mathphrase><emphasis>n</emphasis></mathphrase>
</inlineequation> values.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>marker</code></term>
<listitem>
<para>Given a string value <inlineequation>
<mathphrase><emphasis>x</emphasis></mathphrase>
</inlineequation>, return object names greater in value than the specified
marker.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><code>format</code></term>
<listitem>
<para>Specify either <code>json</code> or <code>xml</code> to return the
respective serialized response, for example append
<programlisting>?format=json</programlisting>onto a query to inform the
service that you want the information serialized in JSON when it is returned
to you.</para>
</listitem>
</varlistentry>
</variablelist>
<para>At this time, a <code>prefix</code> query parameter is not supported at the account
level.</para>
<section><title>Storage Account Services</title>
<para>GET /v1.0/&lt;account&gt;</para>
<para>HEAD /v1.0/&lt;account&gt;</para></section>
<section><title>Storage Container Services</title>
<para>GET /v1.0/&lt;account&gt;/&lt;container&gt;</para>
<para>HEAD /v1.0/&lt;account&gt;/&lt;container&gt;</para>
<para>PUT /v1.0/&lt;account&gt;/&lt;container&gt;</para>
<para>DELETE /v1.0/&lt;account&gt;/&lt;container&gt;</para>
</section>
<section><title>Storage Object Services</title>
<para>GET /v1.0/&lt;account&gt;/&lt;container&gt;/&lt;object&gt;</para>
<para>HEAD /v1.0/&lt;account&gt;/&lt;container&gt;/&lt;object&gt;</para>
<para>PUT /v1.0/&lt;account&gt;/&lt;container&gt;/&lt;object&gt;</para>
<para>DELETE /v1.0/&lt;account&gt;/&lt;container&gt;/&lt;object&gt;</para>
<para>POST /v1.0/&lt;account&gt;/&lt;container&gt;/&lt;object&gt;</para>
</section></section>
</chapter>