Merge "add doc for domain command"

Author: Jenkins

doc/source/command-objects/domain.rst

@@ -0,0 +1,115 @@
+======
+domain
+======
+
+Identity v3
+
+domain create
+-------------
+
+Create new domain
+
+.. program:: domain create
+.. code:: bash
+
+    os domain create
+        [--description <description>]
+        [--enable | --disable]
+        [--or-show]
+        <domain-name>
+
+.. option:: --description <description>
+
+    New domain description
+
+.. option:: --enable
+
+    Enable domain (default)
+
+.. option:: --disable
+
+    Disable domain
+
+.. option:: --or-show
+
+    Return existing domain
+
+    If the domain already exists, return the existing domain data and do not fail.
+
+.. option:: <domain-name>
+
+    New domain name
+
+domain delete
+-------------
+
+Delete domain
+
+.. program:: domain delete
+.. code:: bash
+
+    os domain delete
+        <domain>
+
+.. option:: <domain>
+
+    Domain to delete (name or ID)
+
+domain list
+-----------
+
+List domains
+
+.. program:: domain list
+.. code:: bash
+
+    os domain list
+
+domain set
+----------
+
+Set domain properties
+
+.. program:: domain set
+.. code:: bash
+
+    os domain set
+        [--name <name>]
+        [--description <description>]
+        [--enable | --disable]
+        <domain>
+
+.. option:: --name <name>
+
+    New domain name
+
+.. option:: --description <description>
+
+    New domain description
+
+.. option:: --enable
+
+    Enable domain
+
+.. option:: --disable
+
+    Disable domain
+
+.. option:: <domain>
+
+    Domain to modify (name or ID)
+
+domain show
+-----------
+
+Show domain details
+
+.. program:: domain show
+.. code:: bash
+
+    os domain show
+        <domain>
+
+.. option:: <domain>
+
+    Domain to display (name or ID)

openstackclient/identity/v3/domain.py

@@ -29,7 +29,7 @@
 
 
 class CreateDomain(show.ShowOne):
-    """Create domain command"""
+    """Create new domain"""
 
     log = logging.getLogger(__name__ + '.CreateDomain')
 
@@ -42,7 +42,7 @@ def get_parser(self, prog_name):
         )
         parser.add_argument(
             '--description',
-            metavar='<domain-description>',
+            metavar='<description>',
             help='New domain description',
         )
         enable_group = parser.add_mutually_exclusive_group()
@@ -87,7 +87,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteDomain(command.Command):
-    """Delete domain command"""
+    """Delete domain"""
 
     log = logging.getLogger(__name__ + '.DeleteDomain')
 
@@ -96,7 +96,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'domain',
             metavar='<domain>',
-            help='Name or ID of domain to delete',
+            help='Domain to delete (name or ID)',
         )
         return parser
 
@@ -110,7 +110,7 @@ def take_action(self, parsed_args):
 
 
 class ListDomain(lister.Lister):
-    """List domain command"""
+    """List domains"""
 
     log = logging.getLogger(__name__ + '.ListDomain')
 
@@ -126,7 +126,7 @@ def take_action(self, parsed_args):
 
 
 class SetDomain(command.Command):
-    """Set domain command"""
+    """Set domain properties"""
 
     log = logging.getLogger(__name__ + '.SetDomain')
 
@@ -135,24 +135,24 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'domain',
             metavar='<domain>',
-            help='Name or ID of domain to change',
+            help='Domain to modify (name or ID)',
         )
         parser.add_argument(
             '--name',
-            metavar='<new-domain-name>',
+            metavar='<name>',
             help='New domain name',
         )
         parser.add_argument(
             '--description',
-            metavar='<domain-description>',
+            metavar='<description>',
             help='New domain description',
         )
         enable_group = parser.add_mutually_exclusive_group()
         enable_group.add_argument(
             '--enable',
             dest='enabled',
             action='store_true',
-            help='Enable domain (default)',
+            help='Enable domain',
         )
         enable_group.add_argument(
             '--disable',
@@ -185,7 +185,7 @@ def take_action(self, parsed_args):
 
 
 class ShowDomain(show.ShowOne):
-    """Show domain command"""
+    """Show domain details"""
 
     log = logging.getLogger(__name__ + '.ShowDomain')
 
@@ -194,7 +194,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'domain',
             metavar='<domain>',
-            help='Name or ID of domain to display',
+            help='Domain to display (name or ID)',
         )
         return parser