openstack/nova - nova - OpenDev: Free Software Needs Free Tools

The GET /os-services API takes "host" and "binary" query filter
parameters:
3a5d592e60/nova/api/openstack/compute/services.py (L54-L58)
And novaclient exposes those filters:
https://docs.openstack.org/cli-reference/nova.html#nova-service-list
But they aren't documented in the API reference:
https://developer.openstack.org/api-ref/compute/?expanded=list-compute-services-detail#list-compute-services
Change-Id: I0ed35404d93475538326d3020754a6f97f25d08c
Closes-bug: #1697563 

The fields added in microversions should be at the end (*1).
So fix 'forced_down' parameter added in microversion 2.11.
*1: https://wiki.openstack.org/wiki/NovaAPIRef
TrivialFix
Change-Id: I060cfa2a114e8ce7538554c18095a83cfc2ced10
Implements: blueprint api-ref-in-rst-pike

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

update the os-service Link.
Change-Id: I4485156a0e19a400f1f7218345759bc92bb0e08e

The services data model and API is not per-tenant, it's
per-region, so this change updates the docs to reflect that.
Change-Id: I45bc0bd5afcd05626f61be84c012e00f723f80eb

- Update server_id params to be of type path.
- Cleaned up os-getConsoleOutput action string.
- Made empty response body description more consistent.
 Review and change as needed.
Implements: bp/api-ref-in-rst-ocata
Change-Id: Ie1e299d2b93188240b18138eba9f5b908a1078a4

As service delete will affect host aggregate, add more info
Change-Id: I57b17f60228df83a033735c33cc74589dad30553
Implements: blueprint api-ref-in-rst-ocata

part of bp:api-ref-in-rst
Change-Id: I924a632253b8b1c25f987c259d255cc6440f52f2

Verified parameters, examples, body text.
Included v2.11 sample files for GET and PUT
os-services.
Part of: bp/api-ref-in-rst
Change-Id: Ice4fb525d62230b2e20f01789a0aec396835b56b

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 completes the validation for the admin event interface, including
detailing the codes we currently return in the parameter list.
Because os-service was incorrectly using the 'status' key, when I
renamed status => event_status I needed to also create a
service_status to make things compile. It's accurate enough to move
forward.
Because this is really a Neutron only API, this is moved towards the
bottom of the API list, to make it clear this isn't really designed to
be used by end user apps.
Part of bp:api-ref-in-rst
Change-Id: I3ed46eec1c33a63b7a89d6d6b5eeda574effdc56

This complete the Method Verification of os-services,
http://paste.openstack.org/show/495349/
has the method call and return sample value. also,
clean and correct some error return code.
Part of bp:api-ref-in-rst
Change-Id: Ie4662e033b3b2235e62fd95ea50291ae91362d21

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

This removes the final warnings from the api-ref code base, and flips
the sphinx switch to enforce warnings as errors.
It also adds code to the rest_parameters extension to make it more
clear where a problem is when it comes to included parameters. This
puts us in a place where we can start doing the file per file look at
content.
Part of bp:api-ref-in-rst
Change-Id: Ic2c99d96d6addcafa00b9f16785c2fe59b1798d3

This fixes all the samples references in os-services to not throw
warnings.
Part of bp:api-ref-in-rst
Change-Id: I25b469352a4f99e34783eb31ea3b94e4d9971477

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

"Delete a service " API returns 204 as success, 404 is error
Also some reference to doc it not correct
Part of bp:api-ref-in-rst
Change-Id: Ibf57167ae70acdaa2ad6f0abc3a975c91e797b87

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