Skip to content

Commit

Permalink
Quantum pagination and sorting admin doc
Browse files Browse the repository at this point in the history
Fixes bug 1131155

Change-Id: Iab55791be0d6559516f62f3b1cdc72f53a183d2c
  • Loading branch information
soulxu committed Feb 22, 2013
1 parent 0295129 commit 406e804
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 0 deletions.
41 changes: 41 additions & 0 deletions doc/src/docbkx/openstack-network-connectivity-admin/app_core.xml
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,13 @@
<td>(StrOpt) The plugin to be loaded by the
service. </td>
</tr>
<tr>
<td>
pagination_max_limit=-1 </td>
<td>(StrOpt) The maximum number of items returned
in a single response. A value of 'infinite',
or a negative integer means no limit. </td>
</tr>
</tbody>
</table>

Expand Down Expand Up @@ -162,6 +169,40 @@
<td>(BoolOpt) Enable or disable bulk
create/update/delete operations. </td>
</tr>
<tr>
<td>allow_pagination=False </td>
<td><para>(BoolOpt) Enable or disable pagination.
If plugin doesn't support native pagination, it
will enable emulated pagination. Please note
native pagination depends on native sorting.
If native pagination is enabled, native emulated
sorting will be enabled automatically.</para>
<note>
<para>If the plugin supports native pagination,
the plugin will returns the maximum limit
of items as request. If the plugin didn't
support that, quantum API can emulate the
pagination behavior. The performance of
native pagination is better than emulated
pagiantion. </para>
</note>
</td>
</tr>
<tr>
<td>allow_sorting=False </td>
<td><para>(BoolOpt) Enable or disable sorting. If plugin
doesn't support native sorting, it will enable
emulated sorting.</para>
<note>
<para>If the plugin supports native sorting, the
plugin will returns ordered items as request.
If the plugin didn't support that, quantum API
can emulate the sorting behavior. The performance
of native sorting is better than emulated sorting.
</para>
</note>
</td>
</tr>
<tr>
<td>max_dns_nameservers=5 </td>
<td>(IntOpt) The maximum amount of DNS
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8"?>
<appendix 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="app_pagination_and_sorting_support">
<title>Plugin pagination and sorting support</title>
<table rules="all">
<caption>The plugins are supporting native pagination and
sorting</caption>
<thead>
<tr>
<th>Plugin </th>
<th>Support Native Pagination </th>
<th>Support Native Sorting </th>
</tr>
</thead>

<tbody>
<tr>
<td>Open vSwitch </td>
<td>True </td>
<td>True </td>
</tr>
<tr>
<td>LinuxBridge </td>
<td>True </td>
<td>True </td>
</tr>
</tbody>
</table>
</appendix>
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@
<xi:include href="ch_limitations.xml"/>
<xi:include href="app_demo.xml"/>
<xi:include href="app_core.xml"/>
<xi:include href="app_pagination_and_sorting_support.xml"/>


</book>

0 comments on commit 406e804

Please sign in to comment.