Skip to content

Commit 6c0d4b8

Browse files
Jenkinsopenstack-gerrit
Jenkins
authored and
openstack-gerrit
committed
Merge "Command docs: region"
2 parents ee91203 + b5ce0f1 commit 6c0d4b8

3 files changed

Lines changed: 64 additions & 44 deletions

File tree

‎doc/source/command-objects/region.rst‎

Lines changed: 44 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,86 +9,106 @@ region create
99

1010
Create new region
1111

12+
.. program:: region create
1213
.. code:: bash
1314
1415
os region create
1516
[--parent-region <region-id>]
16-
[--description <region-description>]
17-
[--url <region-url>]
17+
[--description <description>]
18+
[--url <url>]
1819
<region-id>
1920
20-
:option:`--parent-region` <region-id>
21-
Parent region
21+
.. option:: --parent-region <region-id>
22+
23+
Parent region ID
24+
25+
.. option:: --description <description>
2226

23-
:option:`--description` <region-description>
2427
New region description
2528

26-
:option:`--url` <region-url>
29+
.. option:: --url <url>
30+
2731
New region URL
2832

29-
:option:`<region-id>`
33+
.. _region_create-region-id:
34+
.. describe:: <region-id>
35+
3036
New region ID
3137

3238
region delete
3339
-------------
3440

3541
Delete region
3642

43+
.. program:: region delete
3744
.. code:: bash
3845
3946
os region delete
40-
<region>
47+
<region-id>
48+
49+
.. _region_delete-region-id:
50+
.. describe:: <region-id>
4151

42-
:option:`<region>`
43-
Region to delete
52+
Region ID to delete
4453

4554
region list
4655
-----------
4756

4857
List regions
4958

59+
.. program:: region list
5060
.. code:: bash
5161
5262
os region list
5363
[--parent-region <region-id>]
5464
55-
:option:`--parent-region` <region-id>
56-
Filter by a specific parent region
65+
.. option:: --parent-region <region-id>
66+
67+
Filter by parent region ID
5768

5869
region set
5970
----------
6071

6172
Set region properties
6273

74+
.. program:: region set
6375
.. code:: bash
6476
6577
os region set
6678
[--parent-region <region-id>]
67-
[--description <region-description>]
68-
[--url <region-url>]
69-
<region>
79+
[--description <description>]
80+
[--url <url>]
81+
<region-id>
7082
71-
:option:`--parent-region` <region-id>
72-
New parent region
83+
.. option:: --parent-region <region-id>
84+
85+
New parent region ID
86+
87+
.. option:: --description <description>
7388

74-
:option:`--description` <region-description>
7589
New region description
7690

77-
:option:`--url` <region-url>
91+
.. option:: --url <url>
92+
7893
New region URL
7994

80-
:option:`<region>`
95+
.. _region_set-region-id:
96+
.. describe:: <region-id>
97+
8198
Region ID to modify
8299

83100
region show
84101
-----------
85102

86-
Show region
103+
Display region details
87104

105+
.. program:: region show
88106
.. code:: bash
89107
90108
os region show
91-
<region>
109+
<region-id>
92110
93-
:option:`<region>`
94-
Region ID to modify
111+
.. _region_show-region-id:
112+
.. describe:: <region-id>
113+
114+
Region ID to display

‎doc/source/commands.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ referring to both Compute and Volume quotas.
9898
* ``policy``: Identity - determines authorization
9999
* ``project``: (**Identity**) owns a group of resources
100100
* ``quota``: (**Compute**, **Volume**) resource usage restrictions
101-
* ``region``: (**Identity**)
101+
* ``region``: (**Identity**) a subset of an OpenStack deployment
102102
* ``request token``: Identity - temporary OAuth-based token
103103
* ``role``: Identity - a policy object used to determine authorization
104104
* ``security group``: Compute, Network - groups of network access rules

‎openstackclient/identity/v3/region.py‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,22 @@ def get_parser(self, prog_name):
3535
# seems like poor UX, we will only support user-defined IDs.
3636
parser.add_argument(
3737
'region',
38-
metavar='<region>',
39-
help=_('New region'),
38+
metavar='<region-id>',
39+
help=_('New region ID'),
4040
)
4141
parser.add_argument(
4242
'--parent-region',
43-
metavar='<parent-region>',
44-
help=_('The parent region of new region'),
43+
metavar='<region-id>',
44+
help=_('Parent region ID'),
4545
)
4646
parser.add_argument(
4747
'--description',
48-
metavar='<region-description>',
48+
metavar='<description>',
4949
help=_('New region description'),
5050
)
5151
parser.add_argument(
5252
'--url',
53-
metavar='<region-url>',
53+
metavar='<url>',
5454
help=_('New region url'),
5555
)
5656

@@ -82,8 +82,8 @@ def get_parser(self, prog_name):
8282
parser = super(DeleteRegion, self).get_parser(prog_name)
8383
parser.add_argument(
8484
'region',
85-
metavar='<region>',
86-
help=_('Region to delete'),
85+
metavar='<region-id>',
86+
help=_('Region ID to delete'),
8787
)
8888
return parser
8989

@@ -104,8 +104,8 @@ def get_parser(self, prog_name):
104104
parser = super(ListRegion, self).get_parser(prog_name)
105105
parser.add_argument(
106106
'--parent-region',
107-
metavar='<parent-region>',
108-
help=_('Filter by parent region'),
107+
metavar='<region-id>',
108+
help=_('Filter by parent region ID'),
109109
)
110110
return parser
111111

@@ -137,22 +137,22 @@ def get_parser(self, prog_name):
137137
parser = super(SetRegion, self).get_parser(prog_name)
138138
parser.add_argument(
139139
'region',
140-
metavar='<region>',
141-
help=_('Region to change'),
140+
metavar='<region-id>',
141+
help=_('Region ID to modify'),
142142
)
143143
parser.add_argument(
144144
'--parent-region',
145-
metavar='<parent-region>',
146-
help=_('New parent region of the region'),
145+
metavar='<region-id>',
146+
help=_('New parent region ID'),
147147
)
148148
parser.add_argument(
149149
'--description',
150-
metavar='<region-description>',
150+
metavar='<description>',
151151
help=_('New region description'),
152152
)
153153
parser.add_argument(
154154
'--url',
155-
metavar='<region-url>',
155+
metavar='<url>',
156156
help=_('New region url'),
157157
)
158158
return parser
@@ -179,16 +179,16 @@ def take_action(self, parsed_args):
179179

180180

181181
class ShowRegion(show.ShowOne):
182-
"""Show region"""
182+
"""Display region details"""
183183

184184
log = logging.getLogger(__name__ + '.ShowRegion')
185185

186186
def get_parser(self, prog_name):
187187
parser = super(ShowRegion, self).get_parser(prog_name)
188188
parser.add_argument(
189189
'region',
190-
metavar='<region>',
191-
help=_('Region to display'),
190+
metavar='<region-id>',
191+
help=_('Region ID to display'),
192192
)
193193
return parser
194194

0 commit comments

Comments
 (0)