This patch deprecates os-hosts APIs including:
GET /os-hosts - list hosts
GET /os-hosts/{host_name} - show host details
PUT /os-hosts/{host_name} - update host status
GET /os-hosts/{host_name}/reboot - reboot host
GET /os-hosts/{host_name}/shutdown - shutdown host
GET /os-hosts/{host_name}/startup - start host
Much of the ``os-hosts`` API is duplicated with the ``os-services`` and
``os-hypervisors`` APIs. It's not a good idea to make nova have the
compute related API, so this patch deprecated them.
Implements blueprint deprecate-os-hosts
Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>
Change-Id: Ieb85653b85a1eff38a9fb0c9ff05e4cd39150ecc
* Show Host Details
- The parameters in 'resource' object are prefixed
with 'resource.' instead of 'host.'.
- The types of 'cpu', 'memory_mb' and 'disk_gb' are
changed to 'integer'.
- The descriptions of 'cpu', 'memory_mb' and 'disk_gb'
are changed (clearer).
* Update Host status
- The 'status' and 'maintenance_mode' in request
parameters are changed to 'body' parameters
instead of 'path' parameters.
- The 'status' and 'maintenance_mode' in request
parameters are changed to either 'enable' or
'disable'.
- The 'status' and 'maintenance_mode' in response
parameters are changed to 'optional'.
Change-Id: Ic6bffca8b1dfaa9284a72145f3e1f894acb306e3
Closes-Bug: #1653884
As discussed at summit, the version part of the URL is not really
relevant, or a thing a user should be filling out themselves, this
should instead be set by the service catalog and extracted from the
token.
This removes it's reference in all documented REST urls, and adds a
new section describing how one gets the base URL for all calls.
Change-Id: I4306b8c3de0225e54f3909dd8a1fb293c4e5944c
This verify the os-hosts by adding more reponse param
descriptions and body.
Part of bp:api-ref-in-rst
Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
verified the API doc for os-hosts,
Adjust GET/POST sequence in the doc
Also, remove some common error code like 500, 503 etc
Part of bp:api-ref-in-rst
Change-Id: Id8c77d53a589d4203308b8135d5413d00d64d6f1
This adds a set of tags in comments to the beginning of files so that
we can process them according to the documentation here:
https://wiki.openstack.org/wiki/NovaAPIRef
Part of bp:api-ref-in-rst
Change-Id: I17cf584dafb5bd969c12f51b7e7185d92365bf93
Heading for json response example is wrong,
it is json request instead of json response.
Part of bp:api-ref-in-rst
Change-Id: I709b2bf19520eb76e0264c358a2146bb0dbcee2b
In the sphinx document h3 is supposed to be '-' not '^':
=, for sections
-, for subsections
^, for subsubsections
We have to enforce consistency here because we're processing included
files which all have to agree, otherwise it's a sphinx error.
Part of bp:api-ref-in-rst
Change-Id: Ic6eef5cacb07870f161b04b031e332f2b87aeedc
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26