Skip to content

Commit 26dbad5

Browse files
Jenkinsopenstack-gerrit
authored andcommitted
Merge "add doc for role assignment command"
2 parents e5d7122 + e3ba13b commit 26dbad5

2 files changed

Lines changed: 51 additions & 6 deletions

File tree

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
===============
2+
role assignment
3+
===============
4+
5+
Identity v3
6+
7+
role assignment list
8+
--------------------
9+
10+
List role assignments
11+
12+
.. program:: role assignment list
13+
.. code:: bash
14+
15+
os role assignment list
16+
[--role <role>]
17+
[--user <user>]
18+
[--group <group>]
19+
[--domain <domain>]
20+
[--project <project>]
21+
[--effective]
22+
23+
.. option:: --role <role>
24+
25+
Role to filter (name or ID)
26+
27+
.. option:: --user <user>
28+
29+
User to filter (name or ID)
30+
31+
.. option:: --group <group>
32+
33+
Group to filter (name or ID)
34+
35+
.. option:: --domain <domain>
36+
37+
Domain to filter (name or ID)
38+
39+
.. option:: --project <project>
40+
41+
Project to filter (name or ID)
42+
43+
.. option:: --effective
44+
45+
Returns only effective role assignments (defaults to False)

‎openstackclient/identity/v3/role_assignment.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222

2323
class ListRoleAssignment(lister.Lister):
24-
"""Lists role assignments according to the given filters"""
24+
"""List role assignments"""
2525

2626
log = logging.getLogger(__name__ + '.ListRoleAssignment')
2727

@@ -36,29 +36,29 @@ def get_parser(self, prog_name):
3636
parser.add_argument(
3737
'--role',
3838
metavar='<role>',
39-
help='Name or ID of role to filter',
39+
help='Role to filter (name or ID)',
4040
)
4141
user_or_group = parser.add_mutually_exclusive_group()
4242
user_or_group.add_argument(
4343
'--user',
4444
metavar='<user>',
45-
help='Name or ID of user to filter',
45+
help='User to filter (name or ID)',
4646
)
4747
user_or_group.add_argument(
4848
'--group',
4949
metavar='<group>',
50-
help='Name or ID of group to filter',
50+
help='Group to filter (name or ID)',
5151
)
5252
domain_or_project = parser.add_mutually_exclusive_group()
5353
domain_or_project.add_argument(
5454
'--domain',
5555
metavar='<domain>',
56-
help='Name or ID of domain to filter',
56+
help='Domain to filter (name or ID)',
5757
)
5858
domain_or_project.add_argument(
5959
'--project',
6060
metavar='<project>',
61-
help='Name or ID of project to filter',
61+
help='Project to filter (name or ID)',
6262
)
6363

6464
return parser

0 commit comments

Comments
 (0)