Mercurial > p > roundup > code

comparison doc/xmlrpc.txt @ 7734:e34b69d75ff7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: more table call alignment; fix formatting
author John Rouillard <rouilj@ieee.org>
date Mon, 05 Feb 2024 17:22:24 -0500
parents c3a7b1aa06cf
children 57325fea9982
comparison
equal deleted inserted replaced
7733:835b248bf9fd 7734:e34b69d75ff7
92 --------------------------- 92 ---------------------------
93 93
94 See the `rest documentation 94 See the `rest documentation
95 <rest.html#rate-limiting-api-failed-logins>`_ for rate limiting failed 95 <rest.html#rate-limiting-api-failed-logins>`_ for rate limiting failed
96 logins on the API. There is no login rate limiting for the standalone 96 logins on the API. There is no login rate limiting for the standalone
97 roundup-xmlrpc-server. Login rate limiting is only for the `/xmlrpc`` 97 roundup-xmlrpc-server. Login rate limiting is only for the ``/xmlrpc``
98 endpoint when the Roundup server is used. 98 endpoint when the Roundup server is used.
99 99
100 The XML-RPC uses the same method as the REST API. 100 The XML-RPC uses the same method as the REST API.
101 Rate limiting is shared between the XMLRPC and REST APIs. 101 Rate limiting is shared between the XMLRPC and REST APIs.
102 102
105 The server currently implements seven methods/commands. Each method 105 The server currently implements seven methods/commands. Each method
106 requires that the user provide a username and password in the HTTP 106 requires that the user provide a username and password in the HTTP
107 authorization header in order to authenticate the request against the 107 authorization header in order to authenticate the request against the
108 tracker. 108 tracker.
109 109
110 ======= ==================================================================== 110 .. table::
111 Command Description 111 :class: valign-top
112 ======= ==================================================================== 112
113 schema 113 ======= ===================================================================
114 114 Command Description
115 Fetch tracker schema. 115 ======= ===================================================================
116 116 schema Fetch tracker schema.
117 list arguments: *classname, [property_name]* 117
118 118 list arguments: *classname, [property_name]*
119 List all elements of a given ``classname``. If ``property_name`` is 119
120 specified, that is the property that will be displayed for each 120 List all elements of a given ``classname``. If ``property_name``
121 element. If ``property_name`` is not specified the default label 121 is specified, that is the property that will be displayed for each
122 property will be used. 122 element. If ``property_name`` is not specified the default label
123 123 property will be used.
124 display arguments: *designator, [property_1, ..., property_N]* 124
125 125 display arguments: *designator, [property_1, ..., property_N]*
126 Display a single item in the tracker as specified by ``designator`` 126
127 (e.g. issue20 or user5). The default is to display all properties 127 Display a single item in the tracker as specified by ``designator``
128 for the item. Alternatively, a list of properties to display can be 128 (e.g. issue20 or user5). The default is to display all properties
129 specified. 129 for the item. Alternatively, a list of properties to display can
130 130 be specified.
131 create arguments: *classname, arg_1 ... arg_N* 131
132 132 create arguments: *classname, arg_1 ... arg_N*
133 Create a new instance of ``classname`` with ``arg_1`` through 133
134 ``arg_N`` as the values of the new instance. The arguments are 134 Create a new instance of ``classname`` with ``arg_1`` through
135 name=value pairs (e.g. ``status='3'``). 135 ``arg_N`` as the values of the new instance. The arguments are
136 136 name=value pairs (e.g. ``status='3'``).
137 set arguments: *designator, arg_1 ... arg_N* 137
138 138 set arguments: *designator, arg_1 ... arg_N*
139 Set the values of an existing item in the tracker as specified by 139
140 ``designator``. The new values are specified in ``arg_1`` through 140 Set the values of an existing item in the tracker as specified by
141 ``arg_N``. The arguments are name=value pairs (e.g. ``status='3'``). 141 ``designator``. The new values are specified in ``arg_1`` through
142 142 ``arg_N``. The arguments are name=value pairs (e.g. ``status='3'``).
143 lookup arguments: *classname, key_value* 143
144 144 lookup arguments: *classname, key_value*
145 looks up the key_value for the given class. The class needs to 145
146 have a key and the user needs search permission on the key 146 looks up the key_value for the given class. The class needs to
147 attribute and id for the given classname. 147 have a key and the user needs search permission on the key
148 148 attribute and id for the given classname.
149 filter arguments: *classname, list or None, attributes* 149
150 150 filter arguments: *classname, list or None, attributes*
151 ``list`` is a list of ids to filter. It can be set to None to run 151
152 filter over all values (requires ``allow_none=True`` when 152 ``list`` is a list of ids to filter. It can be set to None to
153 instantiating the ServerProxy). The ``attributes`` are given as a 153 run filter over all values (requires ``allow_none=True`` when
154 dictionary of name value pairs to search for. See also 154 instantiating the ServerProxy). The ``attributes`` are given
155 :ref:`query-tracker`. 155 as a dictionary of name value pairs to search for. See also
156 ======= ==================================================================== 156 :ref:`query-tracker`.
157 ======= ===================================================================
157 158
158 Sample Python Client 159 Sample Python Client
159 ==================== 160 ====================
160 161
161 This client will work if you turn off the x-requested-with header and 162 This client will work if you turn off the x-requested-with header and
Roundup Issue Tracker: http://roundup-tracker.org/