openstack
/
api-site
Code Issues Proposed changes

Update object-api wadl to use it in book version for the api 

Partial-Bug: #1187119

Change-Id: Ib7a9781abec89f72c62445c8ae4f22e9890e41a0
author: diane fleming
This commit is contained in:
Diane Fleming 2013-12-31 14:00:26 -06:00
parent bbc3f01a31
commit b1fe44c733
1 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
api-ref/src/wadls/object-api/src/os-object-api-1.0.wadl
View File

@ -132,7 +132,8 @@
body, one container per line.</para>
<para>The HTTP response status code is a value from 200 to
299, inclusive.</para>
<para><b>Serialized list output</b></para>
<para><emphasis role="bold">Serialized list
output</emphasis></para>
<para>If you append the <code>format=xml</code> or
<code>format=json</code> argument to the storage
account URL, the service serves extended container
@ -141,7 +142,8 @@
following example HTTP request asks for a JSON
response, so the response returns an HTTP header and a
JSON response.</para>
<para><b>Control a large number of containers</b></para>
<para><emphasis role="bold">Control a large number of
containers</emphasis></para>
<para>The system returns a maximum of 10,000 container
names for each request. To get subsequent container
names, you must make another request with the marker
@ -202,7 +204,7 @@
response format. Either json or
xml.</para></wadl:doc>
</param>
<!-- <representation mediaType="application/json">
<!-- <representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
title="List containers request: HTTP">
@ -447,8 +449,8 @@
name="X-Container-Object-Count" style="header"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The number of objects. (stored
in header)</para></wadl:doc>
xml:lang="EN"><para>The number of
objects.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Container-Bytes-Used" style="header"
@ -480,8 +482,8 @@
required="false" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The container metadata. *
represents the name of metadata. Stored in
header.</para></wadl:doc>
represents the name of
metadata.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -715,8 +717,8 @@
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The custom object metadata. *
represents the name of metadata. Stored in
header.</para></wadl:doc>
represents the name of
metadata.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -739,17 +741,16 @@
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The container and object name
of the <b>source</b> object in the form of
“/container/object”. Stored in
header.</para></wadl:doc>
of the <emphasis role="italic"
>source</emphasis> object in the form of
“/container/object”.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="Content-Length" style="header" required="true"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The content length, which is
zero under this situation. Stored in
header.</para></wadl:doc>
zero under this situation.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -764,8 +765,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN"
title="Copy object">
<para role="shortdesc">Copies an object to another object
with a new name in the OpenStack Object Storage
system.</para>
with a new name in the Object Storage system.</para>
</wadl:doc>
<request>
<param xmlns="http://wadl.dev.java.net/2009/02"
@ -774,7 +774,7 @@
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The container and object name
of the destination object in the form of
<code>“/container/object”</code>.</para></wadl:doc>
<code>/container/object</code>.</para></wadl:doc>
</param>
<representation mediaType="application/json">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
@ -831,7 +831,8 @@
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"><para>The container metadata. *
represents the name of metadata.</para></wadl:doc>
represents the name of
metadata.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Delete-At" style="header" required="false"