summaryrefslogtreecommitdiffstats
path: root/API.txt
diff options
context:
space:
mode:
authorJan Cholasta <jcholast@redhat.com>2016-06-16 13:21:17 +0200
committerJan Cholasta <jcholast@redhat.com>2016-06-20 16:39:12 +0200
commitec1b3e71b2688eed2264b7b24d9e8fcff938967f (patch)
tree79f670cfd084825743e9e8a1459b70f93a79723c /API.txt
parent3ec7a52aea104ce0f37d9204fcba21a42abfc798 (diff)
downloadfreeipa-ec1b3e71b2688eed2264b7b24d9e8fcff938967f.tar.gz
freeipa-ec1b3e71b2688eed2264b7b24d9e8fcff938967f.tar.xz
freeipa-ec1b3e71b2688eed2264b7b24d9e8fcff938967f.zip
schema: add object class schema
Support object classes defined by object plugins in API schema. Added new commands `class-show` and `class-find` to retrieve information about object classes. `param-show` and `param-find` now support both commands and classes. https://fedorahosted.org/freeipa/ticket/4739 Reviewed-By: David Kupka <dkupka@redhat.com>
Diffstat (limited to 'API.txt')
-rw-r--r--API.txt24
1 files changed, 22 insertions, 2 deletions
diff --git a/API.txt b/API.txt
index 613bf35b7..f2a0686c1 100644
--- a/API.txt
+++ b/API.txt
@@ -843,6 +843,26 @@ option: Str('version?')
output: Entry('result')
output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: PrimaryKey('value')
+command: class_find
+args: 1,4,4
+arg: Str('criteria?')
+option: Flag('all', autofill=True, cli_name='all', default=False)
+option: Flag('pkey_only?', autofill=True, default=False)
+option: Flag('raw', autofill=True, cli_name='raw', default=False)
+option: Str('version?')
+output: Output('count', type=[<type 'int'>])
+output: ListOfEntries('result')
+output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
+output: Output('truncated', type=[<type 'bool'>])
+command: class_show
+args: 1,3,3
+arg: Str('name')
+option: Flag('all', autofill=True, cli_name='all', default=False)
+option: Flag('raw', autofill=True, cli_name='raw', default=False)
+option: Str('version?')
+output: Entry('result')
+output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
+output: PrimaryKey('value')
command: command_defaults
args: 1,3,1
arg: Str('name')
@@ -3324,7 +3344,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: PrimaryKey('value')
command: param_find
args: 2,4,4
-arg: Str('commandname', cli_name='command')
+arg: Str('metaobjectname', cli_name='metaobject')
arg: Str('criteria?')
option: Flag('all', autofill=True, cli_name='all', default=False)
option: Flag('pkey_only?', autofill=True, default=False)
@@ -3336,7 +3356,7 @@ output: Output('summary', type=[<type 'unicode'>, <type 'NoneType'>])
output: Output('truncated', type=[<type 'bool'>])
command: param_show
args: 2,3,3
-arg: Str('commandname', cli_name='command')
+arg: Str('metaobjectname', cli_name='metaobject')
arg: Str('name')
option: Flag('all', autofill=True, cli_name='all', default=False)
option: Flag('raw', autofill=True, cli_name='raw', default=False)