]> review.fuel-infra Code Review - openstack-build/cinder-build.git/commitdiff
Remove obsolete API from documentation
authorIvan Kolodyazhny <e0ne@e0ne.info>
Tue, 14 Jul 2015 15:24:29 +0000 (18:24 +0300)
committerIvan Kolodyazhny <e0ne@e0ne.info>
Tue, 14 Jul 2015 15:57:19 +0000 (18:57 +0300)
Cinder doesn't support EC2 API and doesn't contain cinder.api.ec2
module.
Also references to cinder.api.openstack.auth and cinder.api.cloud were
removed too.

Change-Id: I30f71cf541d93d3ab68780328e2dea6ebd326b63

doc/source/devref/api.rst
doc/source/index.rst

index 1848ae2157e4b0f7683aa8b7f99cff8e0cd0577d..46211733dcdd152e7afd934f6757a1d66ce8f979 100644 (file)
@@ -19,8 +19,7 @@ API Endpoint
 ============
 
 Cinder has a system for managing multiple APIs on different subdomains.
-Currently there is support for the OpenStack API, as well as the Amazon EC2
-API.
+Currently there is support for the OpenStack API.
 
 Common Components
 -----------------
@@ -34,15 +33,6 @@ The :mod:`cinder.api` Module
     :undoc-members:
     :show-inheritance:
 
-The :mod:`cinder.api.cloud` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: cinder.api.cloud
-    :noindex:
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 OpenStack API
 -------------
 
@@ -55,45 +45,6 @@ The :mod:`openstack` Module
     :undoc-members:
     :show-inheritance:
 
-The :mod:`auth` Module
-~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: cinder.api.openstack.auth
-    :noindex:
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-EC2 API
--------
-
-The :mod:`cinder.api.ec2` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: cinder.api.ec2
-    :noindex:
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`cloud` Module
-~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: cinder.api.ec2.cloud
-    :noindex:
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-The :mod:`metadatarequesthandler` Module
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. automodule:: cinder.api.ec2.metadatarequesthandler
-    :noindex:
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 Tests
 -----
 
index 77ddd28be02ab8228d19ae73082e97faad444efc..ef6dba4726fe5cd734cccf17bac4ea8466405c91 100644 (file)
@@ -25,7 +25,6 @@ Cinder is an OpenStack project to provide "block storage as a service".
 * **Fault-Tolerant**: Isolated processes avoid cascading failures
 * **Recoverable**: Failures should be easy to diagnose, debug, and rectify
 * **Open Standards**: Be a reference implementation for a community-driven api
-* **API Compatibility**: Cinder strives to provide API-compatible with popular systems like Amazon EC2
 
 This documentation is generated by the Sphinx toolkit and lives in the source
 tree. Additional draft and project documentation on Cinder and other components of OpenStack can
@@ -59,4 +58,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-r Docs