summaryrefslogtreecommitdiffstats
path: root/ipalib/crud.py
diff options
context:
space:
mode:
authorRob Crittenden <rcritten@redhat.com>2011-01-13 14:29:16 -0500
committerSimo Sorce <ssorce@redhat.com>2011-01-14 14:26:22 -0500
commitc69d8084c17c5d94240bda9447ed9546159608a5 (patch)
treecbb69cb18d98ddea93c0bd1ea1c706026d0fe94e /ipalib/crud.py
parentc94d20cfd8cc1bd8cd8152b19d6807b654286197 (diff)
downloadfreeipa-c69d8084c17c5d94240bda9447ed9546159608a5.tar.gz
freeipa-c69d8084c17c5d94240bda9447ed9546159608a5.tar.xz
freeipa-c69d8084c17c5d94240bda9447ed9546159608a5.zip
Add API version and have server reject incompatible clients.
This patch contains 2 parts. The first part is a small utility to create and validate the current API. To do this it needs to load ipalib which on a fresh system introduces a few problems, namely that it relies on a python plugin to set the default encoding to utf8. For our purposes we can skip that. It is also important that any optional plugins be loadable so the API can be examined. The second part is a version exchange between the client and server. The version has a major and a minor version. The major verion is updated whenever existing API changes. The minor version is updated when new API is added. A request will be rejected if either the major versions don't match or if the client major version is higher than then server major version (though by implication new API would return a command not found if allowed to proceed). To determine the API version of the server from a client use the ping command. ticket 584
Diffstat (limited to 'ipalib/crud.py')
-rw-r--r--ipalib/crud.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/ipalib/crud.py b/ipalib/crud.py
index 6df3c733d..76d57daef 100644
--- a/ipalib/crud.py
+++ b/ipalib/crud.py
@@ -76,7 +76,7 @@ us:
>>> list(api.Command.user_add.args)
['login']
>>> list(api.Command.user_add.options)
-['first', 'last', 'all', 'raw']
+['first', 'last', 'all', 'raw', 'version']
Notice that ``'ipauniqueid'`` isn't included in the options for our ``user_add``
plugin. This is because of the ``'no_create'`` flag we used when defining the
@@ -94,7 +94,7 @@ class created them for us:
>>> list(api.Command.user_show.args)
['login']
>>> list(api.Command.user_show.options)
-['all', 'raw']
+['all', 'raw', 'version']
As you can see, `Retrieve` plugins take a single argument (the primary key) and
no options. If needed, you can still specify options for your `Retrieve` plugin