summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/group.rst
diff options
context:
space:
mode:
authorEric Fried <openstack@fried.cc>2019-11-04 17:16:34 -0600
committerMonty Taylor <mordred@inaugust.com>2020-06-08 16:34:27 -0500
commit26878e7d53a531adb67c9ddde8fd6d3c3092ce34 (patch)
tree1ebf5ccc543312981f9861fb21e813959f82d2fd /doc/source/cli/command-objects/group.rst
parent00e88822e3fcb288d9fe8d019ee7d1bf8dd74630 (diff)
downloadpython-openstackclient-26878e7d53a531adb67c9ddde8fd6d3c3092ce34.tar.gz
identity: autogenerate docs
$namespace = openstack.identity.v{2|3} The subcommand documents for $namespace were hardcoded and thus prone to drift over time. This commit removes the hardcoded content and uses the autoprogram-cliff directive to generate them automatically from the subcommand configuration classes. Special things: - Some reorganization happened here. Certain subcommand names, such as `endpoint` and `project`, are shared by identify v2 and v3. Previously the hardcoded documents had them combined and interleaved. Attempting to preserve this with autoprogram-cliff would have required significant additional infrastructure. However, since most readers care completely about one and not at all about the other, we instead split the v2 and v3 versions of these commands into separate pages. In case links to the old pages exist in the wild, they are preserved, but moved (with redirects) to a hidden directory, and populated simply with links to the new version-specific generated documents. - The `federation domain` and `federation project` subcommands were previously absent from the docs. They are added. These are such small commands and they seem related, so they're put into a single document. - Some pages were already being generated but were listing operations individually instead of using wildcards (possibly because they were created before wildcarding was supported by cliff). These are changed to use wildcarding. (We want to do this wherever possible as it is more future-proof in the event that more operations are added to a subcommand later.) - The `service provider` document was incorrectly titled `identity provider`. Fixed. Change-Id: I2030f9fe370038c5908b6eb6bed9692a73fe5067
Diffstat (limited to 'doc/source/cli/command-objects/group.rst')
-rw-r--r--doc/source/cli/command-objects/group.rst245
1 files changed, 2 insertions, 243 deletions
diff --git a/doc/source/cli/command-objects/group.rst b/doc/source/cli/command-objects/group.rst
index ac938efd..a1071069 100644
--- a/doc/source/cli/command-objects/group.rst
+++ b/doc/source/cli/command-objects/group.rst
@@ -4,246 +4,5 @@ group
Identity v3
-group add user
---------------
-
-Add user to group
-
-.. program:: group add user
-.. code:: bash
-
- openstack group add user
- [--group-domain <group-domain>]
- [--user-domain <user-domain>]
- <group>
- <user> [<user> ...]
-
-.. option:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID). This can be
- used in case collisions between group names exist.
-
- .. versionadded:: 3
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. describe:: <group>
-
- Group to contain <user> (name or ID)
-
-.. describe:: <user>
-
- User(s) to add to <group> (name or ID)
- (repeat option to add multiple users)
-
-group contains user
--------------------
-
-Check user membership in group
-
-.. program:: group contains user
-.. code:: bash
-
- openstack group contains user
- [--group-domain <group-domain>]
- [--user-domain <user-domain>]
- <group>
- <user>
-
-.. option:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID). This can be
- used in case collisions between group names exist.
-
- .. versionadded:: 3
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. describe:: <group>
-
- Group to check (name or ID)
-
-.. describe:: <user>
-
- User to check (name or ID)
-
-group create
-------------
-
-Create new group
-
-.. program:: group create
-.. code:: bash
-
- openstack group create
- [--domain <domain>]
- [--description <description>]
- [--or-show]
- <group-name>
-
-.. option:: --domain <domain>
-
- Domain to contain new group (name or ID)
-
-.. option:: --description <description>
-
- New group description
-
-.. option:: --or-show
-
- Return existing group
-
- If the group already exists, return the existing group data and do not fail.
-
-.. describe:: <group-name>
-
- New group name
-
-group delete
-------------
-
-Delete group
-
-.. program:: group delete
-.. code:: bash
-
- openstack group delete
- [--domain <domain>]
- <group> [<group> ...]
-
-.. option:: --domain <domain>
-
- Domain containing group(s) (name or ID)
-
-.. describe:: <group>
-
- Group(s) to delete (name or ID)
-
-group list
-----------
-
-List groups
-
-.. program:: group list
-.. code:: bash
-
- openstack group list
- [--domain <domain>]
- [--user <user> [--user-domain <user-domain>]]
- [--long]
-
-.. option:: --domain <domain>
-
- Filter group list by <domain> (name or ID)
-
-.. option:: --user <user>
-
- Filter group list by <user> (name or ID)
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. option:: --long
-
- List additional fields in output
-
-group remove user
------------------
-
-Remove user from group
-
-.. program:: group remove user
-.. code:: bash
-
- openstack group remove user
- [--group-domain <group-domain>]
- [--user-domain <user-domain>]
- <group>
- <user> [<user> ...]
-
-.. option:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID). This can be
- used in case collisions between group names exist.
-
- .. versionadded:: 3
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. describe:: <group>
-
- Group containing <user> (name or ID)
-
-.. describe:: <user>
-
- User(s) to remove from <group> (name or ID)
- (repeat option to remove multiple users)
-
-group set
----------
-
-Set group properties
-
-.. program:: group set
-.. code:: bash
-
- openstack group set
- [--domain <domain>]
- [--name <name>]
- [--description <description>]
- <group>
-
-.. option:: --domain <domain>
-
- Domain containing <group> (name or ID)
-
-.. option:: --name <name>
-
- New group name
-
-.. option:: --description <description>
-
- New group description
-
-.. describe:: <group>
-
- Group to modify (name or ID)
-
-group show
-----------
-
-Display group details
-
-.. program:: group show
-.. code:: bash
-
- openstack group show
- [--domain <domain>]
- <group>
-
-.. option:: --domain <domain>
-
- Domain containing <group> (name or ID)
-
-.. describe:: <group>
-
- Group to display (name or ID)
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: group *