Skip to content

Commit

Permalink
Remove support for /os-floating-ip-dns REST API
Browse files Browse the repository at this point in the history
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
  • Loading branch information
stephenfin authored and mriedem committed Jul 19, 2018
1 parent 823c4e8 commit db294b1
Show file tree
Hide file tree
Showing 18 changed files with 84 additions and 958 deletions.
2 changes: 1 addition & 1 deletion api-ref/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@ the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
.. include:: images.inc
.. include:: os-baremetal-nodes.inc
.. include:: os-tenant-network.inc
.. include:: os-floating-ip-dns.inc
.. include:: os-floating-ip-pools.inc
.. include:: os-floating-ips.inc
.. include:: os-security-groups.inc
Expand All @@ -81,3 +80,4 @@ Compute API in the past, but no longer exist.
.. include:: os-virtual-interfaces.inc
.. include:: os-fixed-ips.inc
.. include:: os-floating-ips-bulk.inc
.. include:: os-floating-ip-dns.inc
49 changes: 26 additions & 23 deletions api-ref/source/os-floating-ip-dns.inc
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@

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

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

List Dns Domains
List DNS Domains
================

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

Normal response codes: 200

Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
Error response codes: unauthorized(401), forbidden(403), gone(410),
notImplemented(501)

Response
--------
Expand All @@ -34,7 +36,7 @@ Response
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-list-resp.json
:language: javascript

Create Or Update Dns Domain
Create Or Update DNS Domain
===========================

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

Normal response codes: 200

Error response codes: badRequest(400), unauthorized(401),
forbidden(403), notImplemented(501)
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
gone(410), notImplemented(501)

Request
-------
Expand All @@ -66,7 +68,7 @@ Response
.. literalinclude:: ../../doc/api_samples/os-floating-ip-dns/floating-ip-dns-create-or-update-resp.json
:language: javascript

Delete Dns Domain
Delete DNS Domain
=================

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

Normal response codes: 202

Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)

Request
-------
Expand All @@ -88,7 +90,7 @@ Request
Response
--------

List Dns Entries
List DNS Entries
================

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

Normal response codes: 200

Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)

Request
-------
Expand All @@ -111,12 +113,12 @@ Request
Response
--------

**Example List Dns Entries: JSON response**
**Example List DNS Entries: JSON response**

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

Find Unique Dns Entry
Find Unique DNS Entry
=====================

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

Normal response codes: 200

Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)

Request
-------
Expand All @@ -139,12 +141,12 @@ Request
Response
--------

**Example Find Unique Dns Entry: JSON response**
**Example Find Unique DNS Entry: JSON response**

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

Create Or Update Dns Entry
Create Or Update DNS Entry
==========================

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

Normal response codes: 200

Error response codes: unauthorized(401), forbidden(403), notImplemented(501)
Error response codes: unauthorized(401), forbidden(403), gone(410),
notImplemented(501)

Request
-------
Expand All @@ -163,20 +166,20 @@ Request
- domain: domain
- name: name

**Example Create Or Update Dns Entry: JSON request**
**Example Create Or Update DNS Entry: JSON request**

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

Response
--------

**Example Create Or Update Dns Entry: JSON response**
**Example Create Or Update DNS Entry: JSON response**

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

Delete Dns Entry
Delete DNS Entry
================

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

Normal response codes: 202

Error response codes: unauthorized(401), forbidden(403),
itemNotFound(404), notImplemented(501)
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410), notImplemented(501)

Request
-------
Expand Down
Loading

0 comments on commit db294b1

Please sign in to comment.