openstack/zaqar
Code Issues Proposed changes

Adds partial field deprecation note in the users guide

Browse Source 
This change adds information to the getting started user guide
about the partial attribute deprecation/removal.

Change-Id: I97684ffa7766885990e433304c9b8118b41c3af5
Closes-Bug: #1350437
This commit is contained in:
Victoria Martínez de la Cruz 2014-08-30 15:27:22 -03:00
parent ab1d471d94
commit 0c02c60282
1 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/user-guide/zaqar-get-started/os-zaqar-apiGettingStarted.xml
View File

@ -70,6 +70,12 @@
incubation.</para> incubation.</para>
</revdescription> </revdescription>
</revision> </revision>
<revision>
<date>2014-08-30</date>
<revdescription>
<para>The <parameter>partial</parameter> attribute is no longer supported.</para>
</revdescription>
</revision>
</revhistory> </revhistory>
</info> </info>
<chapter xml:id="doc-change-history"> <chapter xml:id="doc-change-history">
@ -760,13 +766,22 @@ Location: /v1/queues/samplequeue</programlisting>
class="attribute">age</tag>, is added.</para> class="attribute">age</tag>, is added.</para>
<para>The response body contains a list of resource paths <para>The response body contains a list of resource paths
that correspond to each message submitted in the that correspond to each message submitted in the
request, in the same order as they were submitted. If request, in the same order as they were submitted.</para>
a server-side error occurs during the processing of <para>If a server-side error occurs during the processing
the submitted messages, a partial list is returned. of the submitted messages, a partial list is returned.
The <parameter>partial</parameter> attribute is set to The <parameter>partial</parameter> attribute is set to
<parameter>true</parameter>, and the client tries <parameter>true</parameter>, and the client tries
to post the remaining messages again. The to post the remaining messages again.
<parameter>body</parameter> attribute specifies an </para>
<important>
<para>The <parameter>partial</parameter> attribute has been deprecated in the v1.0 API
and is not available in the v1.1 API.
Drivers are now required to operate in a transactional manner.
In other words, either all messages must be posted, or none of them.
</para>
</important>
<para>
The <parameter>body</parameter> attribute specifies an
arbitrary document that constitutes the body of the arbitrary document that constitutes the body of the
message being sent.</para> message being sent.</para>
<para>The following rules apply for the maximum size:<itemizedlist> <para>The following rules apply for the maximum size:<itemizedlist>