openstack/python-openstackclient
Code Issues Proposed changes

Add --inherited to the role docs

Browse Source 
commit Id72670be8640e5c6e2490a6ef849e9ec3493b1a9 forgot to update
the docs for role.rst.

Change-Id: I97c426ea9b290fc266b34cb0bf97de56cfd098de
This commit is contained in:
Steve Martinelli 2015-08-06 22:15:42 -07:00
parent 366d72d87e
commit 51ae8c78b9
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/source/command-objects/role.rst
View File

@ -15,6 +15,7 @@ Add role to a user or group in a project or domain
os role add os role add
--domain <domain> | --project <project> [--project-domain <project-domain>] --domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
--inherited
<role> <role>
.. option:: --domain <domain> .. option:: --domain <domain>
@ -58,6 +59,12 @@ Add role to a user or group in a project or domain
.. versionadded:: 3 .. versionadded:: 3
.. option:: --inherited
Specifies if the role grant is inheritable to the sub projects.
.. versionadded:: 3
.. describe:: <role> .. describe:: <role>
Role to add to `<project>`:`<user>` (name or ID) Role to add to `<project>`:`<user>` (name or ID)
@ -110,6 +117,7 @@ List roles
os role list os role list
--domain <domain> | --project <project> [--project-domain <project-domain>] --domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
--inherited
.. option:: --domain <domain> .. option:: --domain <domain>
@ -156,6 +164,12 @@ List roles
.. versionadded:: 3 .. versionadded:: 3
.. option:: --inherited
Specifies if the role grant is inheritable to the sub projects.
.. versionadded:: 3
role remove role remove
----------- -----------
@ -167,6 +181,7 @@ Remove role from domain/project : user/group
os role remove os role remove
--domain <domain> | --project <project> [--project-domain <project-domain>] --domain <domain> | --project <project> [--project-domain <project-domain>]
--user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>] --user <user> [--user-domain <user-domain>] | --group <group> [--group-domain <group-domain>]
--inherited
<role> <role>
.. option:: --domain <domain> .. option:: --domain <domain>
@ -210,6 +225,12 @@ Remove role from domain/project : user/group
.. versionadded:: 3 .. versionadded:: 3
.. option:: --inherited
Specifies if the role grant is inheritable to the sub projects.
.. versionadded:: 3
.. describe:: <role> .. describe:: <role>
Role to remove (name or ID) Role to remove (name or ID)