From f204eacba181acc025354e566a2fded59d0ecaaf Mon Sep 17 00:00:00 2001
From: Yorhel <git@yorhel.nl>
Date: Fri, 6 Nov 2009 11:48:15 +0100
Subject: API: Added release date filter to get vn, and some d11 updates

---
 data/docs/11 | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

(limited to 'data/docs')

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>
-- 
cgit v1.2.3