nova/doc
Matt Riedemann 622bfb2e95 Handle uuids in os-hypervisors API
There are quite a few changes here as this is not only handling
uuids for the hypervisor id but it's also a refactor in several
APIs for consistency.

The main changes are detailed in the REST API Version History
doc in this change, but to summarize the changes:

* Hypervisor and service IDs are handled as the UUIDs for those
  resources; this is necessary for accurately working with these
  resources across multiple cells.
* The 'servers' and 'search' routes are deprecated and folded into
  the index and detail methods as query parameters, validated using
  json schema.
* The show method will also be able to return the list of servers
  hosted on the given hypervisor using the with_servers query
  parameter.
* The marker used when paging over lists of hypervisors is the
  compute node UUID.
* Using the hypervisor_hostname_pattern query parameter will not
  work with paging parameters.
* API reference docs are updated for the detailed changes.
* Functional and unit tests are provided for all changes.

Part of blueprint service-hyper-uuid-in-api

Change-Id: I828350c179df8bcfa4739910abeafaba2f96982b
2017-07-18 17:08:01 -04:00
..
api_samples Handle uuids in os-hypervisors API 2017-07-18 17:08:01 -04:00
ext doc: Enable pep8 on doc generation code 2017-07-12 14:20:25 +01:00
notification_samples Merge "Handle Cinder 3.27 style attachments in swap_volume" 2017-07-17 21:33:21 +00:00
source doc: Populate the 'cli' section 2017-07-13 14:54:11 +01:00
README.rst Rearranges to create new Compute API Guide 2015-11-12 10:47:23 +00:00

README.rst

OpenStack Nova Documentation README

Both contributor developer documentation and REST API documentation are sourced here.

Contributor developer docs are built to: http://docs.openstack.org/developer/nova/

API guide docs are built to: http://developer.openstack.org/api-guide/compute/

For more details, see the "Building the Documentation" section of doc/source/development.environment.rst.