summaryrefslogtreecommitdiff
path: root/data/docs
diff options
context:
space:
mode:
authorYorhel <git@yorhel.nl>2009-11-06 11:48:15 +0100
committerYorhel <git@yorhel.nl>2009-11-06 11:48:15 +0100
commitf204eacba181acc025354e566a2fded59d0ecaaf (patch)
tree95e9ec684f15631fef697b8bb47b5a22e7f4920c /data/docs
parenteb5970f52a3a0bdbd7077d3590a131b2fe604da5 (diff)
API: Added release date filter to get vn, and some d11 updates
Diffstat (limited to 'data/docs')
-rw-r--r--data/docs/1118
1 files changed, 15 insertions, 3 deletions
diff --git a/data/docs/11 b/data/docs/11
index 5a222372..58b86d4c 100644
--- a/data/docs/11
+++ b/data/docs/11
@@ -52,6 +52,7 @@ server resources and prevent abuse of this service.</p>
<ul>
<li>5 connections per IP. All connections that are opened after reaching this limit will be immediately closed.</li>
<li>3 connections per user. The login command will reply with a 'sesslimit' error when reaching this limit.</li>
+ <li>Each command currently returns at most 10 results. <i>TODO: make configurable?</i></li>
<li><i>more to come...</i></li>
</ul>
@@ -317,7 +318,10 @@ however still required.<br />
<td>id</td>
<td>integer<br />array of integers</td>
<td>= != &gt; &gt;= &lt; &lt;=<br />= !=</td>
- <td>&nbsp;</td>
+ <td>
+ When you need to fetch info about multiple VNs, it is recommended to do so
+ in one command using an array of integers as value. e.g. (id = [7,11,17]).
+ </td>
</tr>
<tr>
<td>title</td>
@@ -332,18 +336,26 @@ however still required.<br />
<td>&nbsp;</td>
</tr>
<tr>
+ <td>released</td>
+ <td>null<br />date (string)</td>
+ <td>= !=<br />= != &gt; &gt;= &lt; &lt;=</td>
+ <td>
+ Note that matching on partial dates (released = "2009") doesn't do what
+ you want, use ranges instead, e.g. (released > "2008" and released <= "2009").
+ </td>
+ <tr class="odd">
<td>platforms</td>
<td>null<br />string<br />array of strings</td>
<td><br />= !=</td>
<td>&nbsp;</td>
</tr>
- <tr class="odd">
+ <tr>
<td>languages</td>
<td>null<br />string<br />array of strings</td>
<td><br />= !=</td>
<td>&nbsp;</td>
</tr>
- <tr>
+ <tr class="odd">
<td>search</td>
<td>string</td>
<td>~</td>