API endpoint documentation.

doc/source/api.rst

@@ -0,0 +1,112 @@
+..
+      Copyright 2010 United States Government as represented by the
+      Administrator of the National Aeronautics and Space Administration. 
+      All Rights Reserved.
+
+      Licensed under the Apache License, Version 2.0 (the "License"); you may
+      not use this file except in compliance with the License. You may obtain
+      a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+      License for the specific language governing permissions and limitations
+      under the License.
+
+API Endpoints
+=============
+
+::
+
+    TODO(todd): get actual docstrings from ec2/osapi_verions instead of @wsgify
+
+Nova 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.
+
+Common Components
+-----------------
+
+The :mod:`nova.api` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`cloud` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.api.cloud
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+OpenStack API
+-------------
+
+The :mod:`openstack` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`auth` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.auth
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`backup_schedules` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.backup_schedules
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`faults` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.faults
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`flavors` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.flavors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`images` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.images
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`ratelimiting` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.ratelimiting
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`servers` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.servers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+The :mod:`sharedipgroups` Module
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. automodule:: nova.api.openstack.sharedipgroups
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/development.guide.rst

@@ -39,21 +39,10 @@ Contents
    compute
    network      
    auth  
+   api
    fakes
 
 
-Older Contents
---------------
-
-.. toctree::
-   :maxdepth: 1
-
-   architecture
-   nova
-   binaries
-   modules
-
-
 Indices and tables
 ------------------
 

doc/source/index.rst

@@ -22,11 +22,11 @@ Nova is a cloud computing fabric controller, the main part of an IaaS system.
 
 Nova is written with the following design guidelines in mind:
 
-* Component based architecture: Quickly add new behaviors
+* **Component based architecture**: Quickly add new behaviors
-* Highly available: Scale to very serious workloads
+* **Highly available**: Scale to very serious workloads
-* Fault-Tollerant: Isloated processes avoid cascading failures
+* **Fault-Tollerant**: Isloated processes avoid cascading failures
-* Recoverable: Failures should be easy to diagnose, debug, and rectify
+* **Recoverable**: Failures should be easy to diagnose, debug, and rectify
-* Open Standards: Be a reference implementation for a community-driven api
+* **Open Standards**: Be a reference implementation for a community-driven api
 
 This documentation is generated by the Sphinx toolkit and lives in the source
 tree.  Additional documentation on Nova and other components of OpenStack can

nova/api/__init__.py

@@ -15,9 +15,15 @@
 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #    License for the specific language governing permissions and limitations
 #    under the License.
-
 """
 Root WSGI middleware for all API controllers.
+
+**Related Flags**
+
+:osapi_subdomain:  subdomain running the OpenStack API (default: api)
+:ec2api_subdomain:  subdomain running the EC2 API (default: ec2)
+:FAKE_subdomain:  set to 'api' or 'ec2', requests default to that endpoint
+
 """
 
 import routes