summaryrefslogtreecommitdiffstats
path: root/API.txt
diff options
context:
space:
mode:
authorMartin Kosek <mkosek@redhat.com>2011-02-04 14:03:30 +0100
committerRob Crittenden <rcritten@redhat.com>2011-02-16 10:39:16 -0500
commite5d57d237b4f146faf2e5c27d4e9eb3359dc15b3 (patch)
treec6998fdaf83372e80e107da4d5dfc7246b552ce9 /API.txt
parenta9dc175bc547996646c213661ca42906ffef83ab (diff)
downloadfreeipa-e5d57d237b4f146faf2e5c27d4e9eb3359dc15b3.tar.gz
freeipa-e5d57d237b4f146faf2e5c27d4e9eb3359dc15b3.tar.xz
freeipa-e5d57d237b4f146faf2e5c27d4e9eb3359dc15b3.zip
HBAC plugin inconsistent output
This patch adds a proper summary text to HBAC command which is then printed out in CLI. Now, HBAC plugin output is consistent with other plugins. https://fedorahosted.org/freeipa/ticket/596
Diffstat (limited to 'API.txt')
-rw-r--r--API.txt12
1 files changed, 8 insertions, 4 deletions
diff --git a/API.txt b/API.txt
index 9e34647d..697acb28 100644
--- a/API.txt
+++ b/API.txt
@@ -1035,13 +1035,17 @@ output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly
output: Output('result', <type 'dict'>, 'list of deletions that failed')
output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
command: hbacrule_disable
-args: 1,0,1
+args: 1,0,3
arg: Str('cn', attribute=True, cli_name='name', label=Gettext('Rule name', domain='ipa', localedir=None), multivalue=False, primary_key=True, query=True, required=True)
-output: Output('result', None, None)
+output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
+output: Output('result', <type 'bool'>, 'True means the operation was successful')
+output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
command: hbacrule_enable
-args: 1,0,1
+args: 1,0,3
arg: Str('cn', attribute=True, cli_name='name', label=Gettext('Rule name', domain='ipa', localedir=None), multivalue=False, primary_key=True, query=True, required=True)
-output: Output('result', None, None)
+output: Output('summary', (<type 'unicode'>, <type 'NoneType'>), 'User-friendly description of action performed')
+output: Output('result', <type 'bool'>, 'True means the operation was successful')
+output: Output('value', <type 'unicode'>, "The primary_key value of the entry, e.g. 'jdoe' for a user")
command: hbacrule_find
args: 1,12,4
arg: Str('criteria?')