Skip to content

Commit b56da8d

Browse files
author
Dean Troyer
committed
Add endpoint v3 docs
(update: change version description formats for API versioning) Change-Id: I499ea1d80ad6ad6392468305f761e695d7261e33
1 parent 457f4c8 commit b56da8d

File tree

3 files changed

+225
-54
lines changed

3 files changed

+225
-54
lines changed

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

Lines changed: 156 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,39 +7,190 @@ Identity v2, v3
77
endpoint create
88
---------------
99

10+
Create new endpoint
11+
12+
*Identity version 2 only*
13+
14+
.. program:: endpoint create
15+
.. code:: bash
16+
17+
os endpoint create
18+
--publicurl <url>
19+
[--adminurl <url>]
20+
[--internalurl <url>]
21+
[--region <region-id>]
22+
<service>
23+
24+
.. option:: --publicurl <url>
25+
26+
New endpoint public URL (required)
27+
28+
.. option:: --adminurl <url>
29+
30+
New endpoint admin URL
31+
32+
.. option:: --internalurl <url>
33+
34+
New endpoint internal URL
35+
36+
.. option:: --region <region-id>
37+
38+
New endpoint region ID
39+
40+
.. _endpoint_create-endpoint:
41+
.. describe:: <service>
42+
43+
New endpoint service (name or ID)
44+
45+
*Identity version 3 only*
46+
1047
.. program:: endpoint create
1148
.. code:: bash
1249
1350
os endpoint create
14-
--publicurl <public-url>
15-
[--adminurl <admin-url>]
16-
[--internalurl <internal-url>]
17-
[--region <endpoint-region>]
51+
[--region <region-id>
52+
[--enable | --disable]
1853
<service>
54+
<interface>
55+
<url>
56+
57+
.. option:: --region <region-id>
58+
59+
New endpoint region ID
60+
61+
.. option:: --enable
62+
63+
Enable endpoint (default)
64+
65+
.. option:: --disable
66+
67+
Disable endpoint
68+
69+
.. describe:: <service>
70+
71+
New endpoint service (name or ID)
72+
73+
.. describe:: <interface>
74+
75+
New endpoint interface type (admin, public or internal)
76+
77+
.. describe:: <url>
78+
79+
New endpoint URL
1980
2081
endpoint delete
2182
---------------
2283
84+
Delete endpoint
85+
2386
.. program:: endpoint delete
2487
.. code:: bash
2588
2689
os endpoint delete
2790
<endpoint-id>
2891
92+
.. _endpoint_delete-endpoint:
93+
.. describe:: <endpoint-id>
94+
95+
Endpoint ID to delete
96+
2997
endpoint list
3098
-------------
3199
100+
List endpoints
101+
32102
.. program:: endpoint list
33103
.. code:: bash
34104
35105
os endpoint list
106+
[--service <service]
107+
[--interface <interface>]
108+
[--region <region-id>]
36109
[--long]
37110
111+
.. option:: --service <service>
112+
113+
Filter by service
114+
115+
*Identity version 3 only*
116+
117+
.. option:: --interface <interface>
118+
119+
Filter by interface type (admin, public or internal)
120+
121+
*Identity version 3 only*
122+
123+
.. option:: --region <region-id>
124+
125+
Filter by region ID
126+
127+
*Identity version 3 only*
128+
129+
.. option:: --long
130+
131+
List additional fields in output
132+
133+
*Identity version 2 only*
134+
135+
endpoint set
136+
------------
137+
138+
Set endpoint properties
139+
140+
*Identity version 3 only*
141+
142+
.. program:: endpoint set
143+
.. code:: bash
144+
145+
os endpoint set
146+
[--region <region-id>]
147+
[--interface <interface>]
148+
[--url <url>]
149+
[--service <service>]
150+
[--enable | --disable]
151+
<endpoint-id>
152+
153+
.. option:: --region <region-id>
154+
155+
New endpoint region ID
156+
157+
.. option:: --interface <interface>
158+
159+
New endpoint interface type (admin, public or internal)
160+
161+
.. option:: --url <url>
162+
163+
New endpoint URL
164+
165+
.. option:: --service <service>
166+
167+
New endpoint service (name or ID)
168+
169+
.. option:: --enable
170+
171+
Enable endpoint
172+
173+
.. option:: --disable
174+
175+
Disable endpoint
176+
177+
.. _endpoint_set-endpoint:
178+
.. describe:: <endpoint-id>
179+
180+
Endpoint ID to modify
181+
38182
endpoint show
39183
-------------
40184
185+
Display endpoint details
186+
41187
.. program:: endpoint show
42188
.. code:: bash
43189
44190
os endpoint show
45-
<endpoint_or_service-type>
191+
<endpoint-id>
192+
193+
.. _endpoint_show-endpoint:
194+
.. describe:: <endpoint-id>
195+
196+
Endpoint ID to display

‎openstackclient/identity/v2_0/endpoint.py‎

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,33 +28,38 @@
2828

2929

3030
class CreateEndpoint(show.ShowOne):
31-
"""Create endpoint"""
31+
"""Create new endpoint"""
3232

3333
log = logging.getLogger(__name__ + '.CreateEndpoint')
3434

3535
def get_parser(self, prog_name):
3636
parser = super(CreateEndpoint, self).get_parser(prog_name)
3737
parser.add_argument(
3838
'service',
39-
metavar='<endpoint-service>',
40-
help=_('New endpoint service'))
41-
parser.add_argument(
42-
'--region',
43-
metavar='<region>',
44-
help=_('New endpoint region'))
39+
metavar='<service>',
40+
help=_('New endpoint service (name or ID)'),
41+
)
4542
parser.add_argument(
4643
'--publicurl',
47-
metavar='<public-url>',
44+
metavar='<url>',
4845
required=True,
49-
help=_('New endpoint public URL'))
46+
help=_('New endpoint public URL (required)'),
47+
)
5048
parser.add_argument(
5149
'--adminurl',
52-
metavar='<admin-url>',
53-
help=_('New endpoint admin URL'))
50+
metavar='<url>',
51+
help=_('New endpoint admin URL'),
52+
)
5453
parser.add_argument(
5554
'--internalurl',
56-
metavar='<internal-url>',
57-
help=_('New endpoint internal URL'))
55+
metavar='<url>',
56+
help=_('New endpoint internal URL'),
57+
)
58+
parser.add_argument(
59+
'--region',
60+
metavar='<region-id>',
61+
help=_('New endpoint region ID'),
62+
)
5863
return parser
5964

6065
def take_action(self, parsed_args):
@@ -76,7 +81,7 @@ def take_action(self, parsed_args):
7681

7782

7883
class DeleteEndpoint(command.Command):
79-
"""Delete endpoint command"""
84+
"""Delete endpoint"""
8085

8186
log = logging.getLogger(__name__ + '.DeleteEndpoint')
8287

@@ -85,7 +90,7 @@ def get_parser(self, prog_name):
8590
parser.add_argument(
8691
'endpoint',
8792
metavar='<endpoint-id>',
88-
help=_('ID of endpoint to delete'))
93+
help=_('Endpoint ID to delete'))
8994
return parser
9095

9196
def take_action(self, parsed_args):
@@ -96,7 +101,7 @@ def take_action(self, parsed_args):
96101

97102

98103
class ListEndpoint(lister.Lister):
99-
"""List endpoint command"""
104+
"""List endpoints"""
100105

101106
log = logging.getLogger(__name__ + '.ListEndpoint')
102107

@@ -106,7 +111,8 @@ def get_parser(self, prog_name):
106111
'--long',
107112
action='store_true',
108113
default=False,
109-
help=_('List additional fields in output'))
114+
help=_('List additional fields in output'),
115+
)
110116
return parser
111117

112118
def take_action(self, parsed_args):
@@ -131,16 +137,17 @@ def take_action(self, parsed_args):
131137

132138

133139
class ShowEndpoint(show.ShowOne):
134-
"""Show endpoint command"""
140+
"""Display endpoint details"""
135141

136142
log = logging.getLogger(__name__ + '.ShowEndpoint')
137143

138144
def get_parser(self, prog_name):
139145
parser = super(ShowEndpoint, self).get_parser(prog_name)
140146
parser.add_argument(
141147
'endpoint_or_service',
142-
metavar='<endpoint_or_service>',
143-
help=_('Endpoint ID or name, type or ID of service to display'))
148+
metavar='<endpoint-id>',
149+
help=_('Endpoint ID to display'),
150+
)
144151
return parser
145152

146153
def take_action(self, parsed_args):

0 commit comments

Comments
 (0)