summaryrefslogtreecommitdiff
path: root/api-ref/source/os-networks.inc
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2019-09-21 22:27:15 +0100
committerStephen Finucane <sfinucan@redhat.com>2019-11-18 16:25:47 +0000
commit1b71252a5fca825ef8d6889b431a3cf7932d6e03 (patch)
tree792acb1fdae11608ebb4934ebd546778bdedcdea /api-ref/source/os-networks.inc
parent3776e97f122494152093bf3e391da209e9bb0bf2 (diff)
downloadnova-1b71252a5fca825ef8d6889b431a3cf7932d6e03.tar.gz
Remove (most) '/os-networks' REST APIs
Drop support for most of the 'os-networks' REST APIs excluding those that proxy through to neutron. This API now returns a 410 response for the non-proxy routes. Unit tests are removed for removed APIs and the functional API sample tests are just asserting the 410 response now same. The latter are also expanded to cover APIs that weren't previously tested. 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 these APIs were removed. Note: yes, the API samples are correct. It really is a useless API when used with neutron. Change-Id: I68bfa77a520382317fc490a4f6c12dd62fc6dcda Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Diffstat (limited to 'api-ref/source/os-networks.inc')
-rw-r--r--api-ref/source/os-networks.inc79
1 files changed, 34 insertions, 45 deletions
diff --git a/api-ref/source/os-networks.inc b/api-ref/source/os-networks.inc
index 99477e266d..a9ee87f69a 100644
--- a/api-ref/source/os-networks.inc
+++ b/api-ref/source/os-networks.inc
@@ -1,28 +1,26 @@
.. -*- rst -*-
-.. NOTE(sdague): These APIs are deprecated so do not update this
- file even body, example or parameters are not complete.
-=====================================
+======================================
Networks (os-networks) (DEPRECATED)
-=====================================
+======================================
-.. warning:: The networks API was designed to work with
- ``nova-network``. Some features are proxied to
- ``neutron`` when appropriate, but as with all translation
- proxies, this is far from perfect compatibility. These
- APIs should be avoided in new applications in favor of
- using ``neutron`` directly. These will fail with a 404
- starting from microversion 2.36.
- See: `Relevant Network APIs
- <https://docs.openstack.org/api-ref/network/v2/#networks>`__.
+.. warning::
+
+ This API was designed to work with ``nova-network`` which was deprecated in
+ the 14.0.0 (Newton) release and removed in the 21.0.0 (Ussuri) release. Some
+ features are proxied to the Network service (neutron) when appropriate, but
+ as with all translation proxies, this is far from perfect compatibility.
+ These APIs should be avoided in new applications in favor of `using
+ neutron directly`__. These will fail with a 404 starting from microversion
+ 2.36. They were removed in the 21.0.0 (Ussuri) release.
+__ https://docs.openstack.org/api-ref/network/v2/#networks
Creates, lists, shows information for, and deletes networks.
Adds network to a project, disassociates a network from a project, and
disassociates a project from a network.
-
Associates host with and disassociates host from a network.
List Networks
@@ -60,7 +58,8 @@ these permissions through the ``policy.json`` file.
Normal response codes: 200
-Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409), NotImplemented(501)
+Error response codes: badRequest(400), unauthorized(401), forbidden(403),
+conflict(409), gone(410), notImplemented(501)
Request
-------
@@ -91,7 +90,8 @@ this operation. Cloud providers can change these permissions through the
Normal response codes: 202
-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
-------
@@ -146,7 +146,8 @@ these permissions through the ``policy.json`` file.
Normal response codes: 202
-Error response codes: unauthorized(401), forbidden(403), itemNotFound(404), conflict(409)
+Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
+conflict(409), gone(410)
Request
-------
@@ -160,15 +161,11 @@ Response
There is no body content for the response of a successful DELETE query.
-Associate Host (DEPRECATED)
-===========================
+Associate Host
+==============
.. rest_method:: POST /os-networks/{network_id}/action
-.. warning::
- This API is only available with ``nova-network`` which is
- deprecated. It should be avoided in any new applications.
-
Associates a network with a host.
Specify the ``associate_host`` action in the request body.
@@ -179,7 +176,8 @@ permissions through the ``policy.json`` file.
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
-------
@@ -199,15 +197,11 @@ Response
There is no body content for the response of a successful POST query.
-Disassociate Network (DEPRECATED)
-=================================
+Disassociate Network
+====================
.. rest_method:: POST /os-networks/{network_id}/action
-.. warning::
- This API is only available with ``nova-network`` which is
- deprecated. It should be avoided in any new applications.
-
Disassociates a network from a project. You can then reuse the network.
Specify the ``disassociate`` action in the request body.
@@ -218,7 +212,8 @@ these permissions through the ``policy.json`` file.
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
-------
@@ -237,15 +232,11 @@ Response
There is no body content for the response of a successful POST query.
-Disassociate Host (DEPRECATED)
-==============================
+Disassociate Host
+=================
.. rest_method:: POST /os-networks/{network_id}/action
-.. warning::
- This API is only available with ``nova-network`` which is
- deprecated. It should be avoided in any new applications.
-
Disassociates a host from a network.
Specify the ``disassociate_host`` action in the request body.
@@ -256,7 +247,8 @@ these permissions through the ``policy.json`` file.
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
-------
@@ -276,15 +268,11 @@ Response
There is no body content for the response of a successful POST query.
-Disassociate Project (DEPRECATED)
-=================================
+Disassociate Project
+====================
.. rest_method:: POST /os-networks/{network_id}/action
-.. warning::
- This API is only available with ``nova-network`` which is
- deprecated. It should be avoided in any new applications.
-
Disassociates a project from a network.
Specify the ``disassociate_project`` action in the request body.
@@ -295,7 +283,8 @@ these permissions through the ``policy.json`` file.
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
-------