Merge "Command doc: consumer"

Author: Jenkins

doc/source/command-objects/consumer.rst

@@ -0,0 +1,83 @@
+========
+consumer
+========
+
+Identity v3
+
+`Requires: OS-OAUTH1 extension`
+
+consumer create
+---------------
+
+Create new consumer
+
+.. program:: consumer create
+.. code:: bash
+
+    os consumer create
+        [--description <description>]
+
+.. option:: --description <description>
+
+    New consumer description
+
+consumer delete
+---------------
+
+Delete a consumer
+
+.. program:: consumer delete
+.. code:: bash
+
+    os consumer delete
+        <consumer>
+
+.. describe:: <consumer>
+
+    Consumer to delete
+
+consumer list
+-------------
+
+List consumers
+
+.. program:: consumer list
+.. code:: bash
+
+    os consumer list
+
+consumer set
+------------
+
+Set consumer properties
+
+.. program:: consumer set
+.. code:: bash
+
+    os 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
+
+    os consumer show
+        <consumer>
+
+.. _consumer_show-consumer:
+.. describe:: <consumer>
+
+    Consumer to display

doc/source/commands.rst

@@ -76,7 +76,7 @@ referring to both Compute and Volume quotas.
 * ``catalog``: (**Identity**) service catalog
 * ``console log``: (**Compute**) server console text dump
 * ``console url``: (**Compute**) server remote console URL
-* ``consumer``: Identity - OAuth-based delegatee
+* ``consumer``: (**Identity**) OAuth-based delegatee
 * ``container``: (**Object Store**) a grouping of objects
 * ``credentials``: (**Identity**) specific to identity providers
 * ``domain``: (**Identity**) a grouping of projects

openstackclient/identity/v3/consumer.py

@@ -27,15 +27,15 @@
 
 
 class CreateConsumer(show.ShowOne):
-    """Create consumer command"""
+    """Create new consumer"""
 
     log = logging.getLogger(__name__ + '.CreateConsumer')
 
     def get_parser(self, prog_name):
         parser = super(CreateConsumer, self).get_parser(prog_name)
         parser.add_argument(
             '--description',
-            metavar='<consumer-description>',
+            metavar='<description>',
             help='New consumer description',
         )
         return parser
@@ -51,7 +51,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteConsumer(command.Command):
-    """Delete consumer command"""
+    """Delete a consumer"""
 
     log = logging.getLogger(__name__ + '.DeleteConsumer')
 
@@ -60,7 +60,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'consumer',
             metavar='<consumer>',
-            help='ID of consumer to delete',
+            help='Consumer to delete',
         )
         return parser
 
@@ -74,7 +74,7 @@ def take_action(self, parsed_args):
 
 
 class ListConsumer(lister.Lister):
-    """List consumer command"""
+    """List consumers"""
 
     log = logging.getLogger(__name__ + '.ListConsumer')
 
@@ -90,7 +90,7 @@ def take_action(self, parsed_args):
 
 
 class SetConsumer(command.Command):
-    """Set consumer command"""
+    """Set consumer properties"""
 
     log = logging.getLogger(__name__ + '.SetConsumer')
 
@@ -99,11 +99,11 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'consumer',
             metavar='<consumer>',
-            help='ID of consumer to change',
+            help='Consumer to modify',
         )
         parser.add_argument(
             '--description',
-            metavar='<new-consumer-description>',
+            metavar='<description>',
             help='New consumer description',
         )
         return parser
@@ -118,7 +118,7 @@ def take_action(self, parsed_args):
             kwargs['description'] = parsed_args.description
 
         if not len(kwargs):
-            sys.stdout.write("Consumer not updated, no arguments present")
+            sys.stdout.write('Consumer not updated, no arguments present')
             return
 
         consumer = identity_client.oauth1.consumers.update(
@@ -127,7 +127,7 @@ def take_action(self, parsed_args):
 
 
 class ShowConsumer(show.ShowOne):
-    """Show consumer command"""
+    """Display consumer details"""
 
     log = logging.getLogger(__name__ + '.ShowConsumer')
 
@@ -136,7 +136,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'consumer',
             metavar='<consumer>',
-            help='ID of consumer to display',
+            help='Consumer to display',
         )
         return parser