Merge "Remove 'os-consoles' API"

4 files changed, 68 insertions, 65 deletions

diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst
index c3fac8adcc..99e3d66636 100644
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@@ -41,7 +41,6 @@ the `API guide <https://docs.openstack.org/api-guide/compute/index.html>`_.
 .. include:: os-aggregates.inc
 .. include:: os-assisted-volume-snapshots.inc
 .. include:: os-availability-zone.inc
-.. include:: os-consoles.inc
 .. include:: os-hypervisors.inc
 .. include:: os-instance-usage-audit-log.inc
 .. include:: os-migrations.inc
@@ -89,4 +88,5 @@ Compute API in the past, but no longer exist.
 .. include:: os-floating-ips-bulk.inc
 .. include:: os-floating-ip-dns.inc
 .. include:: os-cells.inc
+.. include:: os-consoles.inc
 .. include:: os-security-group-default-rules.inc
diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc
index b19bf70665..fe3c654589 100644
--- a/api-ref/source/os-consoles.inc
+++ b/api-ref/source/os-consoles.inc
@@ -1,12 +1,15 @@
 .. -*- rst -*-
 
-===============================================================
- Server consoles (servers, os-consoles, os-console-auth-tokens)
-===============================================================
+==================================================
+ XenServer VNC Proxy (XVP) consoles (os-consoles)
+==================================================
 
-Manages server consoles.
+Manages server XVP consoles.
 
-.. note:: This is only used in Xenserver VNC Proxy.
+.. warning::
+
+   These APIs are only applicable when using the XenServer virt driver.
+   They were removed in the 21.0.0 (Ussuri) release.
 
 Lists Consoles
 ==============
@@ -17,7 +20,7 @@ Lists all consoles for a server.
 
 Normal response codes: 200
 
-Error response codes: unauthorized(401), forbidden(403)
+Error response codes: unauthorized(401), forbidden(403), gone(410)
 
 Request
 -------
@@ -53,7 +56,8 @@ Creates a console for a server.
 
 Normal response codes: 200
 
-Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
+Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
+gone(410)
 
 Request
 -------
@@ -77,7 +81,8 @@ Shows console details for a server.
 
 Normal response codes: 200
 
-Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
+Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
+gone(410)
 
 Request
 -------
@@ -117,7 +122,8 @@ Deletes a console for a server.
 
 Normal response codes: 202
 
-Error response codes: unauthorized(401), forbidden(403), itemNotFound(404)
+Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
+gone(410)
 
 Request
 -------
@@ -132,48 +138,3 @@ Response
 --------
 
 If successful, this method does not return a response body.
-
-
-Show Console Connection Information
-===================================
-
-.. rest_method:: GET /os-console-auth-tokens/{console_token}
-
-Given the console authentication token for a server,
-shows the related connection information.
-
-This method used to be available only for the ``rdp-html5`` console type before
-microversion 2.31. Starting from microversion 2.31 it's available for all
-console types.
-
-Normal response codes: 200
-
-Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
-
-Request
--------
-
-.. rest_parameters:: parameters.yaml
-
-
-  - console_token: console_token
-
-|
-
-Response
---------
-
-.. rest_parameters:: parameters.yaml
-
-  - console: console
-  - instance_uuid: instance_id_body
-  - host: console_host
-  - port: port_number
-  - internal_access_path: internal_access_path
-
-|
-
-**Example Show Console Authentication Token**
-
-.. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json
-   :language: javascript
diff --git a/api-ref/source/servers-action-remote-consoles.inc b/api-ref/source/servers-action-remote-consoles.inc
index 105a00dd10..6e0b7fc9c7 100644
--- a/api-ref/source/servers-action-remote-consoles.inc
+++ b/api-ref/source/servers-action-remote-consoles.inc
@@ -11,7 +11,7 @@ Gets an `RDP <https://technet.microsoft.com/en-us/windowsserver/ee236407>`__ con
 .. warning::
 
    This action is deprecated in microversion 2.5 and superseded
-   by the API `Server Remote Consoles`_ in microversion 2.6.
+   by the API `Server Consoles`_ in microversion 2.6.
    The new API offers a unified API for different console types.
 
 The only supported connect type is ``rdp-html5``. The ``type`` parameter should
@@ -64,7 +64,7 @@ Gets a serial console for a server.
 .. warning::
 
    This action is deprecated in microversion 2.5 and superseded
-   by the API `Server Remote Consoles`_ in microversion 2.6.
+   by the API `Server Consoles`_ in microversion 2.6.
    The new API offers a unified API for different console types.
 
 Specify the ``os-getSerialConsole`` action in the request body.
@@ -117,7 +117,7 @@ Gets a SPICE console for a server.
 .. warning::
 
    This action is deprecated in microversion 2.5 and superseded
-   by the API `Server Remote Consoles`_ in microversion 2.6.
+   by the API `Server Consoles`_ in microversion 2.6.
    The new API offers a unified API for different console types.
 
 Specify the ``os-getSPICEConsole`` action in the request body.
@@ -170,7 +170,7 @@ Gets a VNC console for a server.
 .. warning::
 
    This action is deprecated in microversion 2.5 and superseded
-   by the API `Server Remote Consoles`_ in microversion 2.6.
+   by the API `Server Consoles`_ in microversion 2.6.
    The new API offers a unified API for different console types.
 
 Specify the ``os-getVNCConsole`` action in the request body.
diff --git a/api-ref/source/servers-remote-consoles.inc b/api-ref/source/servers-remote-consoles.inc
index 7bcf96b17c..9aa11af822 100644
--- a/api-ref/source/servers-remote-consoles.inc
+++ b/api-ref/source/servers-remote-consoles.inc
@@ -1,13 +1,13 @@
 .. -*- rst -*-
 
-======================
-Server Remote Consoles
-======================
+=================
+ Server Consoles
+=================
 
-Create server remote console.
+Manage server consoles.
 
-Create Remote Console
-=====================
+Create Console
+==============
 
 .. rest_method:: POST /servers/{server_id}/remote-consoles
 
@@ -56,3 +56,45 @@ Response
 
 .. literalinclude:: ../../doc/api_samples/os-remote-consoles/v2.6/create-vnc-console-resp.json
    :language: javascript
+
+
+Show Console Connection Information
+===================================
+
+.. rest_method:: GET /os-console-auth-tokens/{console_token}
+
+Given the console authentication token for a server, shows the related
+connection information.
+
+This method used to be available only for the ``rdp-html5`` console type before
+microversion 2.31. Starting from microversion 2.31 it's available for all
+console types.
+
+Normal response codes: 200
+
+Error response codes: badRequest(400), unauthorized(401), forbidden(403),
+itemNotFound(404)
+
+Request
+-------
+
+.. rest_parameters:: parameters.yaml
+
+  - console_token: console_token
+
+
+Response
+--------
+
+.. rest_parameters:: parameters.yaml
+
+  - console: console
+  - instance_uuid: instance_id_body
+  - host: console_host
+  - port: port_number
+  - internal_access_path: internal_access_path
+
+**Example Show Console Authentication Token**
+
+.. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json
+   :language: javascript