changeset 4930:f47c35727b3e

Add missing doc for xmlrpc schema (fixes issue2550735)
author Cédric Krier <ced@b2ck.com>
date Wed, 01 Oct 2014 05:29:42 +0300
parents 57a482110a24
children 577b375a1ec2
files doc/xmlrpc.txt
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/xmlrpc.txt	Mon Sep 29 18:37:26 2014 +0300
+++ b/doc/xmlrpc.txt	Wed Oct 01 05:29:42 2014 +0300
@@ -54,6 +54,10 @@
 ======= ====================================================================
 Command Description
 ======= ====================================================================
+schema
+
+        Fetch tracker schema.
+
 list    arguments: *classname, [property_name]*
 
         List all elements of a given ``classname``. If ``property_name`` is
@@ -100,6 +104,8 @@
 
         >>> import xmlrpclib
         >>> roundup_server = xmlrpclib.ServerProxy('http://username:password@localhost:8000/xmlrpc', allow_none=True)
+        >>> roundup_server.schema()
+        {'user': [['username', '<roundup.hyperdb.String>'], ...], 'issue': [...]}
         >>> roundup_server.list('user')
         ['admin', 'anonymous', 'demo']
         >>> roundup_server.list('issue', 'id')

Roundup Issue Tracker: http://roundup-tracker.org/