diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index 788ed6facb..d1aedb3161 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -9,24 +9,30 @@ region create Create new region +.. program:: region create .. code:: bash os region create [--parent-region ] - [--description ] - [--url ] + [--description ] + [--url ] -:option:`--parent-region` - Parent region +.. option:: --parent-region + + Parent region ID + +.. option:: --description -:option:`--description` New region description -:option:`--url` +.. option:: --url + New region URL -:option:`` +.. _region_create-region-id: +.. describe:: + New region ID region delete @@ -34,61 +40,75 @@ region delete Delete region +.. program:: region delete .. code:: bash os region delete - + -:option:`` - Region to delete +.. _region_delete-region-id: +.. describe:: + + Region ID to delete region list ----------- List regions +.. program:: region list .. code:: bash os region list [--parent-region ] -:option:`--parent-region` - Filter by a specific parent region +.. option:: --parent-region + + Filter by parent region ID region set ---------- Set region properties +.. program:: region set .. code:: bash os region set [--parent-region ] - [--description ] - [--url ] - + [--description ] + [--url ] + -:option:`--parent-region` - New parent region +.. option:: --parent-region + + New parent region ID + +.. option:: --description -:option:`--description` New region description -:option:`--url` +.. option:: --url + New region URL -:option:`` +.. _region_set-region-id: +.. describe:: + Region ID to modify region show ----------- -Show region +Display region details +.. program:: region show .. code:: bash os region show - + -:option:`` - Region ID to modify +.. _region_show-region-id: +.. describe:: + + Region ID to display diff --git a/doc/source/commands.rst b/doc/source/commands.rst index d8509d3c54..0040700e86 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -98,7 +98,7 @@ referring to both Compute and Volume quotas. * ``policy``: Identity - determines authorization * ``project``: (**Identity**) owns a group of resources * ``quota``: (**Compute**, **Volume**) resource usage restrictions -* ``region``: (**Identity**) +* ``region``: (**Identity**) a subset of an OpenStack deployment * ``request token``: Identity - temporary OAuth-based token * ``role``: Identity - a policy object used to determine authorization * ``security group``: Compute, Network - groups of network access rules diff --git a/openstackclient/identity/v3/region.py b/openstackclient/identity/v3/region.py index cce3417d5a..5fb7391362 100644 --- a/openstackclient/identity/v3/region.py +++ b/openstackclient/identity/v3/region.py @@ -35,22 +35,22 @@ class CreateRegion(show.ShowOne): # seems like poor UX, we will only support user-defined IDs. parser.add_argument( 'region', - metavar='', - help=_('New region'), + metavar='', + help=_('New region ID'), ) parser.add_argument( '--parent-region', - metavar='', - help=_('The parent region of new region'), + metavar='', + help=_('Parent region ID'), ) parser.add_argument( '--description', - metavar='', + metavar='', help=_('New region description'), ) parser.add_argument( '--url', - metavar='', + metavar='', help=_('New region url'), ) @@ -82,8 +82,8 @@ class DeleteRegion(command.Command): parser = super(DeleteRegion, self).get_parser(prog_name) parser.add_argument( 'region', - metavar='', - help=_('Region to delete'), + metavar='', + help=_('Region ID to delete'), ) return parser @@ -104,8 +104,8 @@ class ListRegion(lister.Lister): parser = super(ListRegion, self).get_parser(prog_name) parser.add_argument( '--parent-region', - metavar='', - help=_('Filter by parent region'), + metavar='', + help=_('Filter by parent region ID'), ) return parser @@ -137,22 +137,22 @@ class SetRegion(command.Command): parser = super(SetRegion, self).get_parser(prog_name) parser.add_argument( 'region', - metavar='', - help=_('Region to change'), + metavar='', + help=_('Region ID to modify'), ) parser.add_argument( '--parent-region', - metavar='', - help=_('New parent region of the region'), + metavar='', + help=_('New parent region ID'), ) parser.add_argument( '--description', - metavar='', + metavar='', help=_('New region description'), ) parser.add_argument( '--url', - metavar='', + metavar='', help=_('New region url'), ) return parser @@ -179,7 +179,7 @@ class SetRegion(command.Command): class ShowRegion(show.ShowOne): - """Show region""" + """Display region details""" log = logging.getLogger(__name__ + '.ShowRegion') @@ -187,8 +187,8 @@ class ShowRegion(show.ShowOne): parser = super(ShowRegion, self).get_parser(prog_name) parser.add_argument( 'region', - metavar='', - help=_('Region to display'), + metavar='', + help=_('Region ID to display'), ) return parser