10 Commits

Author SHA1 Message Date
jichenjc
aad4be2e3d Deprecate os-hosts API
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
2017-04-20 11:58:26 -04:00
Takashi NATSUME
0cbf7bb038 api-ref: Fix parameters in os-hosts.inc
* 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
2017-04-12 00:02:01 +00:00
Sean Dague
c9f5ad3bcf remove /v2.1/{tenant_id} from all urls
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
2016-06-03 08:47:33 -04:00
jichenjc
4f716d9692 api-ref host verification (os-hosts.inc)
This verify the os-hosts by adding more reponse param
descriptions and body.

Part of bp:api-ref-in-rst

Change-Id: Ifefd77c59ae4706d966ac08963ae1246ba038ca9
2016-04-26 16:45:06 +08:00
jichenjc
c2b45cd5cf Complete Verification of os-hosts
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
2016-04-24 08:06:42 +08:00
Sean Dague
d929b9fc76 add tags to files for the content verification phase
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
2016-04-20 16:21:58 -04:00
ghanshyam
6f8cda2f39 Fix json response example heading in api ref
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
2016-04-19 17:56:20 +09:00
jichenjc
fb7b7e7f95 Fix hosts and az api samples
Those 2 files has incorrect api samples, this patch fixs it.

Part of bp:api-ref-in-rst

Change-Id: I71033531fefdb27b191a3a5abb3cba6fbb48b6c1
2016-03-23 13:58:30 +08:00
Sean Dague
9526462326 move sphinx h3 to '-' instead of '^'
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
2016-04-15 07:43:06 -04:00
Sean Dague
d4e2771440 Import RST files for documentation
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
2016-04-13 07:34:45 -04:00