diff options
| author | Eric Fried <openstack@fried.cc> | 2019-11-04 17:16:34 -0600 |
|---|---|---|
| committer | Monty Taylor <mordred@inaugust.com> | 2020-06-08 16:34:27 -0500 |
| commit | 26878e7d53a531adb67c9ddde8fd6d3c3092ce34 (patch) | |
| tree | 1ebf5ccc543312981f9861fb21e813959f82d2fd /doc/source/cli/command-objects/limit.rst | |
| parent | 00e88822e3fcb288d9fe8d019ee7d1bf8dd74630 (diff) | |
| download | python-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/limit.rst')
| -rw-r--r-- | doc/source/cli/command-objects/limit.rst | 127 |
1 files changed, 2 insertions, 125 deletions
diff --git a/doc/source/cli/command-objects/limit.rst b/doc/source/cli/command-objects/limit.rst index 46da6c1b..784d0cb4 100644 --- a/doc/source/cli/command-objects/limit.rst +++ b/doc/source/cli/command-objects/limit.rst @@ -6,128 +6,5 @@ Identity v3 Limits are used to specify project-specific limits thresholds of resources. -limit create ------------- - -Create a new limit - -.. program:: limit create -.. code:: bash - - openstack limit create - [--description <description>] - [--region <region>] - --project <project> - --service <service> - --resource-limit <resource-limit> - <resource-name> - -.. option:: --description <description> - - Useful description of the limit or its purpose - -.. option:: --region <region> - - Region that the limit should be applied to - -.. describe:: --project <project> - - The project that the limit applies to (required) - -.. describe:: --service <service> - - The service that is responsible for the resource being limited (required) - -.. describe:: --resource-limit <resource-limit> - - The limit to apply to the project (required) - -.. describe:: <resource-name> - - The name of the resource to limit (e.g. cores or volumes) - -limit delete ------------- - -Delete project-specific limit(s) - -.. program:: limit delete -.. code:: bash - - openstack limit delete - <limit-id> [<limit-id> ...] - -.. describe:: <limit-id> - - Limit(s) to delete (ID) - -limit list ----------- - -List project-specific limits - -.. program:: limit list -.. code:: bash - - openstack limit list - [--service <service>] - [--resource-name <resource-name>] - [--region <region>] - [--project <project>] - -.. option:: --service <service> - - The service to filter the response by (name or ID) - -.. option:: --resource-name <resource-name> - - The name of the resource to filter the response by - -.. option:: --region <region> - - The region name to filter the response by - -.. option:: --project <project> - - List resource limits associated with project - -limit show ----------- - -Display details about a limit - -.. program:: limit show -.. code:: bash - - openstack limit show - <limit-id> - -.. describe:: <limit-id> - - Limit to display (ID) - -limit set ---------- - -Update a limit - -.. program:: limit show -.. code:: bash - - openstack limit set - [--description <description>] - [--resource-limit <resource-limit>] - <limit-id> - - -.. option:: --description <description> - - Useful description of the limit or its purpose - -.. option:: --resource-limit <resource-limit> - - The limit to apply to the project - -.. describe:: <limit-id> - - Limit to update (ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: limit * |
