summaryrefslogtreecommitdiff
path: root/api-ref/source/index.rst
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2019-02-13 13:19:06 -0500
committerMatt Riedemann <mriedem.os@gmail.com>2019-02-13 13:19:06 -0500
commit3ba8311f6fb065518e885135f6561ecbe235a46e (patch)
treeea12726ed6987304a9f4efb393779bcb2abc1ec0 /api-ref/source/index.rst
parent104d79d8dd05fc49c4160b759d43291b874c5d28 (diff)
downloadnova-3ba8311f6fb065518e885135f6561ecbe235a46e.tar.gz
api-ref: mark os-cells as deprecated
As part of an effort to scrub the nova docs of cells v1 references [1] this moves the os-cells API reference to be grouped with the other deprecated APIs. A section title is added, similar to the "Obsolete APIs" section, for organizational purposes. It should be noted that the os-cells APIs have not been formally deprecated by capping them at some maximum microversion like the other deprecated proxy APIs or for the nova-network APIs, but cells v1 was deprecated in Pike [2] and since the os-cells APIs are admin-only, they can be considered effectively deprecated with the cells v1 deprecation itself, and when we delete the cells v1 service code the APIs will also be gone like the other Obsolete APIs. [1] http://lists.openstack.org/pipermail/openstack-discuss/2019-February/002569.html [2] I1a173f7ce0715e684850e030c358e8175fa8724c Change-Id: I833d2e8d8857448c2922df488ae9d9b425050ddc
Diffstat (limited to 'api-ref/source/index.rst')
-rw-r--r--api-ref/source/index.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst
index d7da32349a..85ff0a954a 100644
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@@ -41,7 +41,6 @@ the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
.. include:: os-aggregates.inc
.. include:: os-assisted-volume-snapshots.inc
.. include:: os-availability-zone.inc
-.. include:: os-cells.inc
.. include:: os-consoles.inc
.. include:: os-hypervisors.inc
.. include:: os-instance-usage-audit-log.inc
@@ -54,6 +53,14 @@ the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
.. include:: os-services.inc
.. include:: os-simple-tenant-usage.inc
.. include:: os-server-external-events.inc
+
+===============
+Deprecated APIs
+===============
+
+This section contains references for APIs which are deprecated and usually
+limited to some maximum microversion.
+
.. include:: extensions.inc
.. include:: os-networks.inc
.. include:: os-volumes.inc
@@ -66,6 +73,7 @@ the `API guide <http://developer.openstack.org/api-guide/compute/index.html>`_.
.. include:: os-security-group-default-rules.inc
.. include:: os-security-group-rules.inc
.. include:: os-hosts.inc
+.. include:: os-cells.inc
=============
Obsolete APIs