Skip to content

Commit db294b1

Browse files
stephenfinmriedem
authored andcommitted
Remove support for /os-floating-ip-dns REST API
Drop support for the os-floating-ip-dns API which has been deprecated since Newton: Idca478c566f9a7b5b30a3172453ce7c66d9fd8f0 This API now returns a 410 response for all routes. Unit tests are removed and the functional API sample tests are just asserting the 410 response now. The API sample docs are left intact since the API reference still builds from those and can be considered more or less branchless, so people looking at the API reference can apply it to older deployments of nova before os-floating-ip-dns was removed. The release note added for previous nova-network API removals is amended to note this additional change. Part of blueprint remove-nova-network Change-Id: I0c4b586292814b8483226aee315f41cbefc86a1e
1 parent 823c4e8 commit db294b1

18 files changed

+84
-958
lines changed

api-ref/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
6060
.. include:: images.inc
6161
.. include:: os-baremetal-nodes.inc
6262
.. include:: os-tenant-network.inc
63-
.. include:: os-floating-ip-dns.inc
6463
.. include:: os-floating-ip-pools.inc
6564
.. include:: os-floating-ips.inc
6665
.. include:: os-security-groups.inc
@@ -81,3 +80,4 @@ Compute API in the past, but no longer exist.
8180
.. include:: os-virtual-interfaces.inc
8281
.. include:: os-fixed-ips.inc
8382
.. include:: os-floating-ips-bulk.inc
83+
.. include:: os-floating-ip-dns.inc

api-ref/source/os-floating-ip-dns.inc

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@
1111

1212
Since these APIs are only implemented for **nova-network**, they are
1313
deprecated. These will fail with a 404 starting from microversion 2.36.
14+
They were removed in the 18.0.0 Rocky release.
1415

1516
Manages DNS records associated with floating IP addresses. The API
1617
dispatches requests to a DNS driver that is selected at startup.
1718

18-
List Dns Domains
19+
List DNS Domains
1920
================
2021

2122
.. rest_method:: GET /os-floating-ip-dns
@@ -24,7 +25,8 @@ Lists registered DNS domains published by the DNS drivers.
2425

2526
Normal response codes: 200
2627

27-
Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
28+
Error response codes: unauthorized(401), forbidden(403), gone(410),
29+
notImplemented(501)
2830

2931
Response
3032
--------
@@ -34,7 +36,7 @@ Response
3436
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-list-resp.json
3537
:language: javascript
3638

37-
Create Or Update Dns Domain
39+
Create Or Update DNS Domain
3840
===========================
3941

4042
.. rest_method:: PUT /os-floating-ip-dns/{domain}
@@ -43,8 +45,8 @@ Creates or updates a DNS domain.
4345

4446
Normal response codes: 200
4547

46-
Error response codes: badRequest(400), unauthorized(401),
47-
forbidden(403), notImplemented(501)
48+
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
49+
gone(410), notImplemented(501)
4850

4951
Request
5052
-------
@@ -66,7 +68,7 @@ Response
6668
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-resp.json
6769
:language: javascript
6870

69-
Delete Dns Domain
71+
Delete DNS Domain
7072
=================
7173

7274
.. rest_method:: DELETE /os-floating-ip-dns/{domain}
@@ -75,8 +77,8 @@ Deletes a DNS domain and all associated host entries.
7577

7678
Normal response codes: 202
7779

78-
Error response codes: unauthorized(401), forbidden(403),
79-
itemNotFound(404), notImplemented(501)
80+
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
81+
gone(410), notImplemented(501)
8082

8183
Request
8284
-------
@@ -88,7 +90,7 @@ Request
8890
Response
8991
--------
9092

91-
List Dns Entries
93+
List DNS Entries
9294
================
9395

9496
.. rest_method:: GET /os-floating-ip-dns/{domain}/entries/{ip}
@@ -97,8 +99,8 @@ Lists DNS entries for a domain and IP.
9799

98100
Normal response codes: 200
99101

100-
Error response codes: unauthorized(401), forbidden(403),
101-
itemNotFound(404), notImplemented(501)
102+
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
103+
gone(410), notImplemented(501)
102104

103105
Request
104106
-------
@@ -111,12 +113,12 @@ Request
111113
Response
112114
--------
113115

114-
**Example List Dns Entries: JSON response**
116+
**Example List DNS Entries: JSON response**
115117

116118
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-list-resp.json
117119
:language: javascript
118120

119-
Find Unique Dns Entry
121+
Find Unique DNS Entry
120122
=====================
121123

122124
.. rest_method:: GET /os-floating-ip-dns/{domain}/entries/{name}
@@ -125,8 +127,8 @@ Finds a unique DNS entry for a domain and name.
125127

126128
Normal response codes: 200
127129

128-
Error response codes: unauthorized(401), forbidden(403),
129-
itemNotFound(404), notImplemented(501)
130+
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
131+
gone(410), notImplemented(501)
130132

131133
Request
132134
-------
@@ -139,12 +141,12 @@ Request
139141
Response
140142
--------
141143

142-
**Example Find Unique Dns Entry: JSON response**
144+
**Example Find Unique DNS Entry: JSON response**
143145

144146
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-entry-get-resp.json
145147
:language: javascript
146148

147-
Create Or Update Dns Entry
149+
Create Or Update DNS Entry
148150
==========================
149151

150152
.. rest_method:: PUT /os-floating-ip-dns/{domain}/entries/{name}
@@ -153,7 +155,8 @@ Creates or updates a DNS entry.
153155

154156
Normal response codes: 200
155157

156-
Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
158+
Error response codes: unauthorized(401), forbidden(403), gone(410),
159+
notImplemented(501)
157160

158161
Request
159162
-------
@@ -163,20 +166,20 @@ Request
163166
- domain: domain
164167
- name: name
165168

166-
**Example Create Or Update Dns Entry: JSON request**
169+
**Example Create Or Update DNS Entry: JSON request**
167170

168171
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-req.json
169172
:language: javascript
170173

171174
Response
172175
--------
173176

174-
**Example Create Or Update Dns Entry: JSON response**
177+
**Example Create Or Update DNS Entry: JSON response**
175178

176179
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-entry-resp.json
177180
:language: javascript
178181

179-
Delete Dns Entry
182+
Delete DNS Entry
180183
================
181184

182185
.. rest_method:: DELETE /os-floating-ip-dns/{domain}/entries/{name}
@@ -185,8 +188,8 @@ Deletes a DNS entry.
185188

186189
Normal response codes: 202
187190

188-
Error response codes: unauthorized(401), forbidden(403),
189-
itemNotFound(404), notImplemented(501)
191+
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
192+
gone(410), notImplemented(501)
190193

191194
Request
192195
-------

0 commit comments

Comments
 (0)