diff options
| author | John Garbutt <john.garbutt@rackspace.com> | 2015-11-25 12:47:01 +0000 |
|---|---|---|
| committer | John Garbutt <john.garbutt@rackspace.com> | 2015-11-25 12:56:29 +0000 |
| commit | fa602a3ff586ce7a3336ffbac9a54e47cb41f85d (patch) | |
| tree | 6ea811784e864bd127c358b14587f56ac1b162cf /api-guide/source/index.rst | |
| parent | f680989dd7edca4aaf9746ff2d59787c2e016703 (diff) | |
| download | nova-fa602a3ff586ce7a3336ffbac9a54e47cb41f85d.tar.gz | |
api-guide: fix up navigation bar
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
Diffstat (limited to 'api-guide/source/index.rst')
| -rw-r--r-- | api-guide/source/index.rst | 40 |
1 files changed, 13 insertions, 27 deletions
diff --git a/api-guide/source/index.rst b/api-guide/source/index.rst index 5ea5771a93..bc3fcf054c 100644 --- a/api-guide/source/index.rst +++ b/api-guide/source/index.rst @@ -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 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 `bugs.launchpad.net/nova <http://bugs.launchpad.net/nova>`__. - Intended audience ================= @@ -40,9 +43,8 @@ following concepts: * HTTP/1.1 * JSON data serialization formats - -Versions and Extensions -======================= +API Versions +============ Following the Liberty release, every Nova deployment should have the following endpoints: @@ -52,27 +54,19 @@ the following endpoints: * /v1.1 - an alias for v2.0 for backwards compatibility * /v2.1 - same API, except uses microversions -For more information on how to make use the API, how to get the endpoint -from the keystone service catalog and pick what version of the API to use, -please read: +While this guide concentrates on documenting the v2.1 API, +please note that the v2.0 and v1.1 API are (almost) identical to first +microversion of the v2.1 API and are also covered by this guide. + +Contents +======== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 versions extensions microversions - - -Key API concepts -================ - -The following documents go into more details about the key concepts of the -OpenStack Compute API: - -.. toctree:: - :maxdepth: 2 - general_info server_concepts authentication @@ -82,11 +76,3 @@ OpenStack Compute API: paginated_collections polling_changes-since_parameter 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>`__. |