openstack/nova
Code Issues Proposed changes

api-guide: fix up navigation bar

Browse Source 
The current navigation bar includes a strange gap in it due to how the
toctrees are currently arranged in the document. This moves them into a
single list.

blueprint complete-todo-in-api-concept-doc

Change-Id: I3c6c68bafb589887e32a990e0cccf1bff9e68518
This commit is contained in:
John Garbutt 2015-11-25 12:47:01 +00:00
parent f680989dd7
commit fa602a3ff5
1 changed files with 14 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
api-guide/source/index.rst
View File

@ -22,10 +22,13 @@ Through this API, the service provides massively scalable, on demand,
self-service access to compute resources. Depending on the deployment those self-service access to compute resources. Depending on the deployment those
compute resources might be Virtual Machines, Physical Machines or Containers. compute resources might be Virtual Machines, Physical Machines or Containers.
This guide covers the concepts in the OpenStack Compute API.
For a full reference listing, please see:
`Compute API Reference <http://developer.openstack.org/api-ref-compute-v2.1.html>`__.
We welcome feedback, comments, and bug reports at We welcome feedback, comments, and bug reports at
`bugs.launchpad.net/nova <http://bugs.launchpad.net/nova>`__. `bugs.launchpad.net/nova <http://bugs.launchpad.net/nova>`__.
Intended audience Intended audience
================= =================
@ -40,9 +43,8 @@ following concepts:
* HTTP/1.1 * HTTP/1.1
* JSON data serialization formats * JSON data serialization formats
API Versions
Versions and Extensions ============
=======================
Following the Liberty release, every Nova deployment should have Following the Liberty release, every Nova deployment should have
the following endpoints: the following endpoints:
@ -52,27 +54,19 @@ the following endpoints:
* /v1.1 - an alias for v2.0 for backwards compatibility * /v1.1 - an alias for v2.0 for backwards compatibility
* /v2.1 - same API, except uses microversions * /v2.1 - same API, except uses microversions
For more information on how to make use the API, how to get the endpoint While this guide concentrates on documenting the v2.1 API,
from the keystone service catalog and pick what version of the API to use, please note that the v2.0 and v1.1 API are (almost) identical to first
please read: microversion of the v2.1 API and are also covered by this guide.
.. toctree:: Contents
:maxdepth: 1 ========
versions
extensions
microversions
Key API concepts
================
The following documents go into more details about the key concepts of the
OpenStack Compute API:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
versions
extensions
microversions
general_info general_info
server_concepts server_concepts
authentication authentication
@ -82,11 +76,3 @@ OpenStack Compute API:
paginated_collections paginated_collections
polling_changes-since_parameter polling_changes-since_parameter
request_and_response_formats request_and_response_formats
Full reference
==============
For a full reference listing for the OpenStack Compute API, please see:
* `*Compute API reference (CURRENT)* <http://developer.openstack.org/api-ref-compute-v2.1.html>`__.