summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/consumer.rst
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2017-10-21 04:54:11 +0000
committerGerrit Code Review <review@openstack.org>2017-10-21 04:54:11 +0000
commit6c0b96681325c77711b168435a610b74c674a5ea (patch)
tree491a978c4d5216d9fc58e208c69b42ce92744e2c /doc/source/cli/command-objects/consumer.rst
parent3abba6ede9ea01fbdfc94a13e3252b7b98d56c34 (diff)
parent0d94a76d956c0322e9c4607fb5ce824f7653f038 (diff)
downloadpython-openstackclient-6c0b96681325c77711b168435a610b74c674a5ea.tar.gz
Merge "auto-generate docs for v3 identity resources"
Diffstat (limited to 'doc/source/cli/command-objects/consumer.rst')
-rw-r--r--doc/source/cli/command-objects/consumer.rst87
1 files changed, 13 insertions, 74 deletions
diff --git a/doc/source/cli/command-objects/consumer.rst b/doc/source/cli/command-objects/consumer.rst
index d4ce5dc5..8f6dda0a 100644
--- a/doc/source/cli/command-objects/consumer.rst
+++ b/doc/source/cli/command-objects/consumer.rst
@@ -2,82 +2,21 @@
consumer
========
-Identity v3
+An **consumer** is used by the Identity service's OS-OAUTH1 extension. It
+is used to create a **request token** and **access token**. Applicable to
+Identity v3.
-`Requires: OS-OAUTH1 extension`
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: consumer create
-consumer create
----------------
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: consumer delete
-Create new consumer
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: consumer list
-.. program:: consumer create
-.. code:: bash
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: consumer set
- openstack consumer create
- [--description <description>]
-
-.. option:: --description <description>
-
- New consumer description
-
-consumer delete
----------------
-
-Delete consumer(s)
-
-.. program:: consumer delete
-.. code:: bash
-
- openstack consumer delete
- <consumer> [<consumer> ...]
-
-.. describe:: <consumer>
-
- Consumer(s) to delete
-
-consumer list
--------------
-
-List consumers
-
-.. program:: consumer list
-.. code:: bash
-
- openstack consumer list
-
-consumer set
-------------
-
-Set consumer properties
-
-.. program:: consumer set
-.. code:: bash
-
- openstack consumer set
- [--description <description>]
- <consumer>
-
-.. option:: --description <description>
-
- New consumer description
-
-.. describe:: <consumer>
-
- Consumer to modify
-
-consumer show
--------------
-
-Display consumer details
-
-.. program:: consumer show
-.. code:: bash
-
- openstack consumer show
- <consumer>
-
-.. _consumer_show-consumer:
-.. describe:: <consumer>
-
- Consumer to display
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: consumer show