Skip to content

Commit fa57d3d

Browse files
committed
Fix issue with docs references and failing tox docs
1 parent d8b6a78 commit fa57d3d

3 files changed

Lines changed: 41 additions & 42 deletions

File tree

doc/source/sdk/guides/vpcep.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ List Services
2222

2323
This interface is used to query an VPCEP services list and to filter
2424
the output with query parameters.
25-
:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
25+
:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
2626

2727
.. literalinclude:: ../examples/vpcep/list_endpoints.py
2828
:lines: 14-20
@@ -32,7 +32,7 @@ Create Service
3232

3333
This interface is used to create a VPCEP service with
3434
parameters.
35-
:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
35+
:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
3636

3737
.. literalinclude:: ../examples/vpcep/create_service.py
3838
:lines: 14-30
@@ -42,7 +42,7 @@ Get Service
4242

4343
This interface is used to get a VPCEP service by ID
4444
or an instance of class.
45-
:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
45+
:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
4646

4747
.. literalinclude:: ../examples/vpcep/get_service.py
4848
:lines: 14-21
@@ -52,7 +52,7 @@ Find Service
5252

5353
This interface is used to find a VPCEP service by ID
5454
or name.
55-
:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
55+
:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
5656

5757
.. literalinclude:: ../examples/vpcep/find_service.py
5858
:lines: 14-21
@@ -62,7 +62,7 @@ Delete Service
6262

6363
This interface is used to delete a VPCEP service by ID
6464
or an instance of class
65-
:class:`~otcextensions.sdk.vpcep.v2.service.Service`.
65+
:class:`~otcextensions.sdk.vpcep.v1.service.Service`.
6666

6767
.. literalinclude:: ../examples/vpcep/delete_service.py
6868
:lines: 14-20
@@ -72,7 +72,7 @@ List Service Whitelist
7272

7373
This interface is used to query an VPCEP service whitelist and to filter
7474
the output with query parameters.
75-
:class:`~otcextensions.sdk.vpcep.v2.whitelist.Whitelist`.
75+
:class:`~otcextensions.sdk.vpcep.v1.whitelist.Whitelist`.
7676

7777
.. literalinclude:: ../examples/vpcep/list_service_whitelist.py
7878
:lines: 14-22
@@ -81,7 +81,7 @@ Manage Service Whitelist
8181
^^^^^^^^^^^^^^^^^^^^^^^^
8282

8383
This interface is used to manage a VPCEP service whitelist.
84-
:class:`~otcextensions.sdk.vpcep.v2.whitelist.Whitelist`.
84+
:class:`~otcextensions.sdk.vpcep.v1.whitelist.Whitelist`.
8585

8686
.. literalinclude:: ../examples/vpcep/manage_service_whitelist.py
8787
:lines: 14-26
@@ -91,7 +91,7 @@ List Service Connections
9191

9292
This interface is used to query an VPCEP service connections and to filter
9393
the output with query parameters.
94-
:class:`~otcextensions.sdk.vpcep.v2.connection.Connection`.
94+
:class:`~otcextensions.sdk.vpcep.v1.connection.Connection`.
9595

9696
.. literalinclude:: ../examples/vpcep/list_service_connections.py
9797
:lines: 14-22
@@ -100,7 +100,7 @@ Manage Service Connections
100100
^^^^^^^^^^^^^^^^^^^^^^^^^^
101101

102102
This interface is used to manage a VPCEP service connections.
103-
:class:`~otcextensions.sdk.vpcep.v2.connection.Connection`.
103+
:class:`~otcextensions.sdk.vpcep.v1.connection.Connection`.
104104

105105
.. literalinclude:: ../examples/vpcep/manage_service_connections.py
106106
:lines: 14-25
@@ -116,7 +116,7 @@ List Endpoints
116116

117117
This interface is used to query an VPC endpoint list and to filter
118118
the output with query parameters.
119-
:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
119+
:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
120120

121121
.. literalinclude:: ../examples/vpcep/list_endpoints.py
122122
:lines: 14-20
@@ -126,7 +126,7 @@ Create Endpoint
126126

127127
This interface is used to create a VPC endpoint with
128128
parameters.
129-
:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
129+
:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
130130

131131
.. literalinclude:: ../examples/vpcep/create_endpoint.py
132132
:lines: 14-28
@@ -136,7 +136,7 @@ Get Endpoint
136136

137137
This interface is used to get a VPC endpoint by ID
138138
or an instance of class
139-
:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
139+
:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
140140

141141
.. literalinclude:: ../examples/vpcep/get_endpoint.py
142142
:lines: 14-21
@@ -146,7 +146,7 @@ Delete Endpoint
146146

147147
This interface is used to delete a VPC endpoint by ID
148148
or an instance of class
149-
:class:`~otcextensions.sdk.vpcep.v2.endpoint.Endpoint`.
149+
:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`.
150150

151151
.. literalinclude:: ../examples/vpcep/delete_endpoint.py
152152
:lines: 14-20
@@ -159,8 +159,7 @@ List Resource Quota
159159

160160
This interface is used to query quota of vpc endpoint and endpoint_service
161161
on a specific tenant.
162-
:class:`~otcextensions.sdk.vpcep.v2.quota.Quota`.
162+
:class:`~otcextensions.sdk.vpcep.v1.quota.Quota`.
163163

164164
.. literalinclude:: ../examples/vpcep/list_resource_quota.py
165165
:lines: 14-20
166-

doc/source/sdk/resources/vpcep/v1/connection.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
otcextensions.sdk.vpecp.v1.connection
1+
otcextensions.sdk.vpcep.v1.connection
22
=====================================
33

44
.. automodule:: otcextensions.sdk.vpcep.v1.connection

otcextensions/sdk/vpcep/v1/_proxy.py

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ def endpoints(self, **query):
3434
:param dict query: Optional query parameters to be sent to limit
3535
the resources being returned. Valid parameters are:
3636
:returns: A generator of endpoint objects
37-
:rtype: :class:`~otcextensions.sdk.vpcep.endpoint.Endpoint`
37+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`
3838
"""
3939
if query.get("limit"):
4040
query.update(paginated=False)
@@ -44,11 +44,11 @@ def create_endpoint(self, **attrs):
4444
"""Create a new endpoint from attributes
4545
4646
:param dict attrs: Keyword arguments which will be used to create a
47-
:class:`~otcextensions.sdk.vpcep.endpoint.Endpoint`,
47+
:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`,
4848
comprised of the properties on the Endpoint class.
4949
5050
:returns: The results of endpoint creation
51-
:rtype: :class:`~otcextensions.sdk.vpcep.endpoint.Endpoint`
51+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`
5252
"""
5353
if attrs.get("ip") and attrs.get("port_ip"):
5454
raise TypeError(
@@ -63,10 +63,10 @@ def get_endpoint(self, endpoint):
6363
"""Get a single endpoint
6464
6565
:param endpoint: The value can be the ID of a endpoint or a
66-
:class:`~otcextensions.sdk.vpcep.endpoint.Endpoint`
66+
:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`
6767
instance.
6868
69-
:returns: One :class:`~otcextensions.sdk.vpcep.endpoint.Endpoint`
69+
:returns: One :class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint`
7070
:raises: :class:`~openstack.exceptions.ResourceNotFound`
7171
when no resource can be found.
7272
@@ -77,7 +77,7 @@ def delete_endpoint(self, endpoint, ignore_missing=True):
7777
"""Delete a endpoint
7878
7979
:param endpoint: The value can be either the ID of a endpoint or a
80-
:class:`~otcextensions.sdk.vpcep.endpoint.Endpoint` instance.
80+
:class:`~otcextensions.sdk.vpcep.v1.endpoint.Endpoint` instance.
8181
:param bool ignore_missing: When set to ``False``
8282
:class:`~openstack.exceptions.ResourceNotFound` will be
8383
raised when the endpoint does not exist.
@@ -97,7 +97,7 @@ def services(self, **query):
9797
the resources being returned. Valid parameters are:
9898
9999
:returns: A generator of endpoint service objects
100-
:rtype: :class:`~otcextensions.sdk.vpcep.service.Service`
100+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.service.Service`
101101
"""
102102
if query.get("limit"):
103103
query.update(paginated=False)
@@ -107,22 +107,22 @@ def create_service(self, **attrs):
107107
"""Create a new endpoint service from attributes
108108
109109
:param dict attrs: Keyword arguments which will be used to create a
110-
:class:`~otcextensions.sdk.vpcep.service.Service`,
110+
:class:`~otcextensions.sdk.vpcep.v1.service.Service`,
111111
comprised of the properties on the Service class.
112112
113113
:returns: The results of endpoint service creation
114-
:rtype: :class:`~otcextensions.sdk.vpcep.service.Service`
114+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.service.Service`
115115
"""
116116
return self._create(_service.Service, **attrs)
117117

118118
def get_service(self, service):
119119
"""Get a single endpoint service
120120
121121
:param service: The value can be the ID of a endpoint service or a
122-
:class:`~otcextensions.sdk.vpcep.service.Service`
122+
:class:`~otcextensions.sdk.vpcep.v1.service.Service`
123123
instance.
124124
125-
:returns: One :class:`~otcextensions.sdk.vpcep.service.Service`
125+
:returns: One :class:`~otcextensions.sdk.vpcep.v1.service.Service`
126126
:raises: :class:`~openstack.exceptions.ResourceNotFound`
127127
when no resource can be found.
128128
@@ -139,7 +139,7 @@ def find_service(self, name_or_id, ignore_missing=False):
139139
When set to ``True``, None will be returned when
140140
attempting to find a nonexistent resource.
141141
142-
:returns: One :class:`~otcextensions.sdk.vpcep.service.Service`
142+
:returns: One :class:`~otcextensions.sdk.vpcep.v1.service.Service`
143143
or None
144144
"""
145145
return self._find(
@@ -152,20 +152,20 @@ def update_service(self, service, **attrs):
152152
"""Update a endpoint service
153153
154154
:param service: The service can be either the ID or a
155-
:class:`~otcextensions.sdk.vpcep.service.Service` instance.
155+
:class:`~otcextensions.sdk.vpcep.v1.service.Service` instance.
156156
:param dict attrs: The attributes to update on the endpoint service
157157
represented by ``service``.
158158
159159
:returns: The updated service
160-
:rtype: :class:`~otcextensions.sdk.vpcep.service.Service`
160+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.service.Service`
161161
"""
162162
return self._update(_service.Service, service, **attrs)
163163

164164
def delete_service(self, service, ignore_missing=True):
165165
"""Delete a endpoint service
166166
167167
:param service: The service can be either the ID or a
168-
:class:`~otcextensions.sdk.vpcep.service.Service` instance.
168+
:class:`~otcextensions.sdk.vpcep.v1.service.Service` instance.
169169
:param bool ignore_missing: When set to ``False``
170170
:class:`~openstack.exceptions.ResourceNotFound` will be raised when
171171
the service does not exist.
@@ -186,12 +186,12 @@ def service_connections(self, service, **query):
186186
"""Return a generator of service connections
187187
188188
:param service: The service can be either the ID or a
189-
:class:`~otcextensions.sdk.vpcep.service.Service` instance.
189+
:class:`~otcextensions.sdk.vpcep.v1.service.Service` instance.
190190
:param dict query: Optional query parameters to be sent to limit
191191
the resources being returned. Valid parameters are:
192192
193193
:returns: A generator of connection objects.
194-
:rtype: :class:`~otcextensions.sdk.vpcep.connection.Connection`
194+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.connection.Connection`
195195
"""
196196
if query.get("limit"):
197197
query.update(paginated=False)
@@ -204,7 +204,7 @@ def manage_service_connections(self, service, action, endpoints=[]):
204204
"""Manage endpoint service connections
205205
206206
:param service: The service can be either the ID or a
207-
:class:`~otcextensions.sdk.vpcep.service.Service` instance.
207+
:class:`~otcextensions.sdk.vpcep.v1.service.Service` instance.
208208
:param action: action can be ``accept`` or ``reject``.
209209
:param endpoints: List of VPC Endpoints Id.
210210
@@ -228,12 +228,12 @@ def service_whitelist(self, service, **query):
228228
"""Return a generator of service whitelist
229229
230230
:param service: The service can be either the ID or a
231-
:class:`~otcextensions.sdk.vpcep.service.Service` instance.
231+
:class:`~otcextensions.sdk.vpcep.v1.service.Service` instance.
232232
:param dict query: Optional query parameters to be sent to limit
233233
the resources being returned. Valid parameters are:
234234
235235
:returns: A generator of whitelist objects.
236-
:rtype: :class:`~otcextensions.sdk.vpcep.whitelist.Whitelist`
236+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.whitelist.Whitelist`
237237
"""
238238
if query.get("limit"):
239239
query.update(paginated=False)
@@ -246,12 +246,12 @@ def manage_service_whitelist(self, service, action, domains=[]):
246246
"""Manage endpoint service whitelist
247247
248248
:param service: The service can be either the ID or a
249-
:class:`~otcextensions.sdk.vpcep.service.Service` instance.
249+
:class:`~otcextensions.sdk.vpcep.v1.service.Service` instance.
250250
:param action: action can be ``add`` or ``remove``.
251251
:param domains: List of domains Ids to be added to whitelist.
252252
253253
:returns: A generator of whitelist objects.
254-
:rtype: :class:`~otcextensions.sdk.vpcep.whitelist.Whitelist`
254+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.whitelist.Whitelist`
255255
"""
256256
endpoint_service = self._get_resource(_service.Service, service)
257257
whitelist = self._get_resource(
@@ -274,7 +274,7 @@ def public_services(self, **query):
274274
the resources being returned. Valid parameters are:
275275
276276
:returns: A generator of public endpoint service objects
277-
:rtype: :class:`~otcextensions.sdk.vpcep.public_service.PublicService`
277+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.public_service.PublicService`
278278
"""
279279
if query.get("limit"):
280280
query.update(paginated=False)
@@ -287,7 +287,7 @@ def get_target_service(self, name_or_id, ignore_missing=False):
287287
288288
:param name_or_id: The value can be the ID of a endpoint service,
289289
name of a endpoint service or a
290-
:class:`~otcextensions.sdk.vpcep.target_service.TargetService`
290+
:class:`~otcextensions.sdk.vpcep.v1.target_service.TargetService`
291291
instance.
292292
:param bool ignore_missing: When set to ``False``
293293
:class:`~openstack.exceptions.ResourceNotFound` will be
@@ -296,7 +296,7 @@ def get_target_service(self, name_or_id, ignore_missing=False):
296296
attempting to find a nonexistent resource.
297297
298298
:returns: One
299-
:class:`~otcextensions.sdk.vpcep.target_service.TargetService`
299+
:class:`~otcextensions.sdk.vpcep.v1.target_service.TargetService`
300300
:raises: :class:`~openstack.exceptions.ResourceNotFound`
301301
when no resource can be found.
302302
@@ -336,7 +336,7 @@ def resource_quota(self, type=None):
336336
type can be: ``endpoint`` or ``endpoint_service``
337337
338338
:returns: A generator of quota objects.
339-
:rtype: :class:`~otcextensions.sdk.vpcep.quota.Quota`
339+
:rtype: :class:`~otcextensions.sdk.vpcep.v1.quota.Quota`
340340
"""
341341
query = {}
342342
if type:

0 commit comments

Comments
 (0)