expand a bit on the xmlrpc extensions in the docs

This commit is contained in:
Mike McLean 2017-06-23 17:19:19 -04:00
parent be2fae90ae
commit 3d44e974d3

View file

@ -589,5 +589,14 @@ API. You can get listing of all available calls, arguments and basic help via
calling `koji list-api` command. This call will also provide you API
extensions provided by plugins in that particular koji instance.
In addition to xmlrpc standard we are using `i8` extension for large
integers. Datetimes are exchanged as text strings in iso format.
Because of the data Koji routinely deals with, we use the following extensions
to the xmlrpc standard:
* We use the ``nil`` extension to represent null values (e.g. None in
Python). Koji's library handles this automatically. If you are using a
different library, you may need to explicitly enable this (e.g. enabling
allow_none in Python's own xmlrpc library).
* We represent large integers with the ``i8`` tag. This standard is borrowed
from Apache's `ws-xmlrpc <https://ws.apache.org/xmlrpc/types.html>`
implementation. Python's own xmlrpc library understands this tag, even
thought it will not emit it.