Document filter method of xmlrpc interface

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk@4361 57a73879-2fb5-44c3-a270-3262357dd7e2

diff --git a/CHANGES.txt b/CHANGES.txt
index 81f08fb5aa4e71ac19f117110c4ba9e9c8120440..91232fbac43b8a114b793c18fd03c9c22d4abe65 100644 (file)
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -20,6 +20,7 @@ Fixes:
 - Small fix for CGI-handling of XMLRPC requests for python2.4, this
   worked only for 2.5 and beyond due to a change in the xmlrpc interface
   in python
+- Document filter method of xmlrpc interface
 
 2009-08-10 1.4.9 (r4346)
 

diff --git a/doc/xmlrpc.txt b/doc/xmlrpc.txt
index c071992418bfe57486eb835d86710d3aa131237d..c054715d5cd1158d8fea21e76418a422cbaa784e 100644 (file)
--- a/doc/xmlrpc.txt
+++ b/doc/xmlrpc.txt
@@ -64,6 +64,13 @@ set     arguments: *designator, arg_1 ... arg_N*
         Set the values of an existing item in the tracker as specified by
         ``designator``. The new values are specified in ``arg_1`` through
         ``arg_N``. The arguments are name=value pairs (e.g. ``status='3'``).
+
+filter  arguments: *classname, list or None, attributes*
+        
+        list can be None (requires ``allow_none=True`` when
+        instantiating the ServerProxy) to indicate search for all values,
+        or a list of ids. The attributes are given as a dictionary of
+        name value pairs to search for.
 ======= ====================================================================
 
 sample python client
@@ -71,7 +78,7 @@ sample python client
 ::
 
         >>> import xmlrpclib
-        >>> roundup_server = xmlrpclib.ServerProxy('http://username:password@localhost:8000')
+        >>> roundup_server = xmlrpclib.ServerProxy('http://username:password@localhost:8000', allow_none=True)
         >>> roundup_server.list('user')
         ['admin', 'anonymous', 'demo']
         >>> roundup_server.list('issue', 'id')
@@ -85,4 +92,11 @@ sample python client
         {'status' : '3' }
         >>> roundup_server.create('issue', "title='another bug'", "status=2")
         '2'
-
+        >>> roundup_server.filter('user',None,{'username':'adm'})
+        ['1']
+        >>> roundup_server.filter('user',['1','2'],{'username':'adm'})
+        ['1']
+        >>> roundup_server.filter('user',['2'],{'username':'adm'})
+        []
+        >>> roundup_server.filter('user',[],{'username':'adm'})
+        []