summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2014-12-24 15:15:26 +0000
committerGerrit Code Review <review@openstack.org>2014-12-24 15:15:26 +0000
commit26dbad5cfb013fc1624936fa9bc6b11b6662b9cf (patch)
treefa8e27e1cfffa67598405e67bc98a87d97bebd27
parente5d71221adb17d05d14a1a692aed39dfc217151f (diff)
parente3ba13b32091831a7e5750d670921fce29424067 (diff)
downloadpython-openstackclient-26dbad5cfb013fc1624936fa9bc6b11b6662b9cf.tar.gz
Merge "add doc for role assignment command"
-rw-r--r--doc/source/command-objects/role_assignment.rst45
-rw-r--r--openstackclient/identity/v3/role_assignment.py12
2 files changed, 51 insertions, 6 deletions
diff --git a/doc/source/command-objects/role_assignment.rst b/doc/source/command-objects/role_assignment.rst
new file mode 100644
index 00000000..749d883e
--- /dev/null
+++ b/doc/source/command-objects/role_assignment.rst
@@ -0,0 +1,45 @@
+===============
+role assignment
+===============
+
+Identity v3
+
+role assignment list
+--------------------
+
+List role assignments
+
+.. program:: role assignment list
+.. code:: bash
+
+ os role assignment list
+ [--role <role>]
+ [--user <user>]
+ [--group <group>]
+ [--domain <domain>]
+ [--project <project>]
+ [--effective]
+
+.. option:: --role <role>
+
+ Role to filter (name or ID)
+
+.. option:: --user <user>
+
+ User to filter (name or ID)
+
+.. option:: --group <group>
+
+ Group to filter (name or ID)
+
+.. option:: --domain <domain>
+
+ Domain to filter (name or ID)
+
+.. option:: --project <project>
+
+ Project to filter (name or ID)
+
+.. option:: --effective
+
+ Returns only effective role assignments (defaults to False)
diff --git a/openstackclient/identity/v3/role_assignment.py b/openstackclient/identity/v3/role_assignment.py
index 5cc97e8d..f053b608 100644
--- a/openstackclient/identity/v3/role_assignment.py
+++ b/openstackclient/identity/v3/role_assignment.py
@@ -21,7 +21,7 @@ from openstackclient.common import utils
class ListRoleAssignment(lister.Lister):
- """Lists role assignments according to the given filters"""
+ """List role assignments"""
log = logging.getLogger(__name__ + '.ListRoleAssignment')
@@ -36,29 +36,29 @@ class ListRoleAssignment(lister.Lister):
parser.add_argument(
'--role',
metavar='<role>',
- help='Name or ID of role to filter',
+ help='Role to filter (name or ID)',
)
user_or_group = parser.add_mutually_exclusive_group()
user_or_group.add_argument(
'--user',
metavar='<user>',
- help='Name or ID of user to filter',
+ help='User to filter (name or ID)',
)
user_or_group.add_argument(
'--group',
metavar='<group>',
- help='Name or ID of group to filter',
+ help='Group to filter (name or ID)',
)
domain_or_project = parser.add_mutually_exclusive_group()
domain_or_project.add_argument(
'--domain',
metavar='<domain>',
- help='Name or ID of domain to filter',
+ help='Domain to filter (name or ID)',
)
domain_or_project.add_argument(
'--project',
metavar='<project>',
- help='Name or ID of project to filter',
+ help='Project to filter (name or ID)',
)
return parser