Merge "Add endpoint v3 docs"

Author: Jenkins

doc/source/command-objects/endpoint.rst

@@ -7,39 +7,190 @@ Identity v2, v3
 endpoint create
 ---------------
 
+Create new endpoint
+
+*Identity version 2 only*
+
+.. program:: endpoint create
+.. code:: bash
+
+    os endpoint create
+        --publicurl <url>
+        [--adminurl <url>]
+        [--internalurl <url>]
+        [--region <region-id>]
+        <service>
+
+.. option:: --publicurl <url>
+
+    New endpoint public URL (required)
+
+.. option:: --adminurl <url>
+
+    New endpoint admin URL
+
+.. option:: --internalurl <url>
+
+    New endpoint internal URL
+
+.. option:: --region <region-id>
+
+    New endpoint region ID
+
+.. _endpoint_create-endpoint:
+.. describe:: <service>
+
+    New endpoint service (name or ID)
+
+*Identity version 3 only*
+
 .. program:: endpoint create
 .. code:: bash
 
     os endpoint create
-        --publicurl <public-url>
-        [--adminurl <admin-url>]
-        [--internalurl <internal-url>]
-        [--region <endpoint-region>]
+        [--region <region-id>
+        [--enable | --disable]
         <service>
+        <interface>
+        <url>
+
+.. option:: --region <region-id>
+
+    New endpoint region ID
+
+.. option:: --enable
+
+    Enable endpoint (default)
+
+.. option:: --disable
+
+    Disable endpoint
+
+.. describe:: <service>
+
+    New endpoint service (name or ID)
+
+.. describe:: <interface>
+
+    New endpoint interface type (admin, public or internal)
+
+.. describe:: <url>
+
+    New endpoint URL
 
 endpoint delete
 ---------------
 
+Delete endpoint
+
 .. program:: endpoint delete
 .. code:: bash
 
     os endpoint delete
         <endpoint-id>
 
+.. _endpoint_delete-endpoint:
+.. describe:: <endpoint-id>
+
+    Endpoint ID to delete
+
 endpoint list
 -------------
 
+List endpoints
+
 .. program:: endpoint list
 .. code:: bash
 
     os endpoint list
+        [--service <service]
+        [--interface <interface>]
+        [--region <region-id>]
         [--long]
 
+.. option:: --service <service>
+
+    Filter by service
+
+    *Identity version 3 only*
+
+.. option:: --interface <interface>
+
+    Filter by interface type (admin, public or internal)
+
+    *Identity version 3 only*
+
+.. option:: --region <region-id>
+
+    Filter by region ID
+
+    *Identity version 3 only*
+
+.. option:: --long
+
+    List additional fields in output
+
+    *Identity version 2 only*
+
+endpoint set
+------------
+
+Set endpoint properties
+
+*Identity version 3 only*
+
+.. program:: endpoint set
+.. code:: bash
+
+    os endpoint set
+        [--region <region-id>]
+        [--interface <interface>]
+        [--url <url>]
+        [--service <service>]
+        [--enable | --disable]
+        <endpoint-id>
+
+.. option:: --region <region-id>
+
+    New endpoint region ID
+
+.. option:: --interface <interface>
+
+    New endpoint interface type (admin, public or internal)
+
+.. option:: --url <url>
+
+    New endpoint URL
+
+.. option:: --service <service>
+
+    New endpoint service (name or ID)
+
+.. option:: --enable
+
+    Enable endpoint
+
+.. option:: --disable
+
+    Disable endpoint
+
+.. _endpoint_set-endpoint:
+.. describe:: <endpoint-id>
+
+    Endpoint ID to modify
+
 endpoint show
 -------------
 
+Display endpoint details
+
 .. program:: endpoint show
 .. code:: bash
 
     os endpoint show
-        <endpoint_or_service-type>
+        <endpoint-id>
+
+.. _endpoint_show-endpoint:
+.. describe:: <endpoint-id>
+
+    Endpoint ID to display

openstackclient/identity/v2_0/endpoint.py

@@ -28,33 +28,38 @@
 
 
 class CreateEndpoint(show.ShowOne):
-    """Create endpoint"""
+    """Create new endpoint"""
 
     log = logging.getLogger(__name__ + '.CreateEndpoint')
 
     def get_parser(self, prog_name):
         parser = super(CreateEndpoint, self).get_parser(prog_name)
         parser.add_argument(
             'service',
-            metavar='<endpoint-service>',
-            help=_('New endpoint service'))
-        parser.add_argument(
-            '--region',
-            metavar='<region>',
-            help=_('New endpoint region'))
+            metavar='<service>',
+            help=_('New endpoint service (name or ID)'),
+        )
         parser.add_argument(
             '--publicurl',
-            metavar='<public-url>',
+            metavar='<url>',
             required=True,
-            help=_('New endpoint public URL'))
+            help=_('New endpoint public URL (required)'),
+        )
         parser.add_argument(
             '--adminurl',
-            metavar='<admin-url>',
-            help=_('New endpoint admin URL'))
+            metavar='<url>',
+            help=_('New endpoint admin URL'),
+        )
         parser.add_argument(
             '--internalurl',
-            metavar='<internal-url>',
-            help=_('New endpoint internal URL'))
+            metavar='<url>',
+            help=_('New endpoint internal URL'),
+        )
+        parser.add_argument(
+            '--region',
+            metavar='<region-id>',
+            help=_('New endpoint region ID'),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -76,7 +81,7 @@ def take_action(self, parsed_args):
 
 
 class DeleteEndpoint(command.Command):
-    """Delete endpoint command"""
+    """Delete endpoint"""
 
     log = logging.getLogger(__name__ + '.DeleteEndpoint')
 
@@ -85,7 +90,7 @@ def get_parser(self, prog_name):
         parser.add_argument(
             'endpoint',
             metavar='<endpoint-id>',
-            help=_('ID of endpoint to delete'))
+            help=_('Endpoint ID to delete'))
         return parser
 
     def take_action(self, parsed_args):
@@ -96,7 +101,7 @@ def take_action(self, parsed_args):
 
 
 class ListEndpoint(lister.Lister):
-    """List endpoint command"""
+    """List endpoints"""
 
     log = logging.getLogger(__name__ + '.ListEndpoint')
 
@@ -106,7 +111,8 @@ def get_parser(self, prog_name):
             '--long',
             action='store_true',
             default=False,
-            help=_('List additional fields in output'))
+            help=_('List additional fields in output'),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -131,16 +137,17 @@ def take_action(self, parsed_args):
 
 
 class ShowEndpoint(show.ShowOne):
-    """Show endpoint command"""
+    """Display endpoint details"""
 
     log = logging.getLogger(__name__ + '.ShowEndpoint')
 
     def get_parser(self, prog_name):
         parser = super(ShowEndpoint, self).get_parser(prog_name)
         parser.add_argument(
             'endpoint_or_service',
-            metavar='<endpoint_or_service>',
-            help=_('Endpoint ID or name, type or ID of service to display'))
+            metavar='<endpoint-id>',
+            help=_('Endpoint ID to display'),
+        )
         return parser
 
     def take_action(self, parsed_args):