22 Commits

Author SHA1 Message Date
ForestLee
fb3d6afc62 update the description of hypervisor statistics response
The description of hypervisor statistics response was not for one
hypervisor, but all hypervisors. So I will modify the description
from "this hypervisor" to "all hypervisors".

Change-Id: I5b92732a9044e3ce4b18568b8b37f3e6ffc2c929
Closes-Bug: #1687871
2018-02-05 22:32:54 -05:00
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
Matt Riedemann
298565a762 api-ref: cleanup PUT /os-hypervisors/statistics docs
There are two changes here:

1. It is important to state that this API only returns a summary
   of compute node/service statistics for *enabled* nova-compute
   services. The DB API query filters out disabled compute services.

2. Fixes a typo in the description of the hypervisor_statistics
   parameter.

Change-Id: Iee28147b701ab42eb07d344cd2f4cb157b74b2f2
2017-06-15 00:32:47 +00:00
Jenkins
a1eab9e40b Merge "Rework descriptions in os-hypervisors" 2017-04-25 21:15:06 +00:00
Kevin_Zheng
b0e844d331 Rework descriptions in os-hypervisors
The description for os-hypervisors is incorrect

TrivialFix

Change-Id: I26b4a815c5b00a35906c579895fd9c77d2332b12
2017-04-24 08:58:52 +00:00
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
jichenjc
70f39ab57f api-ref: Body verification for os-hypervisors.inc
Change-Id: Ia826591a416774a777e08f286f257962fa776258
Implements: blueprint api-ref-in-rst-pike
2017-02-23 12:03:14 +08:00
Takashi NATSUME
070656a478 api-ref: Fix path parameters in os-hypervisors.inc
The hypervisor ID in path parameters have been fixed to 'integer'.
In "Search Hypervisor" and "List Hypervisor Servers",
the hypervisor IDs have been fixed to a string for searching
hypervisor host names.

Change-Id: I2260f0c4ca82d5a2ae5a46bcf8f48f9eaaf09f2f
Closes-Bug: #1654197
2017-01-26 23:40:12 +00:00
Diana Clarke
29c6e08fe8 api-ref: use the examples with paging links
Use the microversion response samples that include the paging links in
the example JSON responses.

Change-Id: I99ef8e8e709b0262f3038bf19e8746782c9f302a
2017-01-05 10:56:13 -05:00
jichenjc
6178700598 Add hypervisor_links into hypervisor v2.33
added hypervisor_links into response of hypervisor we need to
add it

Also, verified sample.

Implements: blueprint api-ref-in-rst

Change-Id: I38241f116482a99609e5892a9e20ea5496d89f2b
2016-09-09 21:28:19 +08:00
Alex Szarka
2a1aad9de7 Fixed typos in api-ref and releasenotes directory
This patchset fixes the typo errors in api-ref and
releasenotes directories.
TrivialFix

Change-Id: Ib72e5c4ac7539c1b08adc858b9b3a0071cb3c866
2016-07-20 09:08:50 +00:00
Chen Fan
f860cb5cf9 api-ref: fix wrong description about response example in os-hypervisor
change response sample file description from request to response

Change-Id: I50a5d7f2edf24f5a2c4beb84e303e95921b6f208
Implements: blueprint api-ref-in-rst
2016-07-08 10:38:17 +08:00
liyingjun
ec53c6c0ec Microversion 2.33 adds pagination support for hypervisors
When there are thousands of compute nodes, it would be slow to get the
whole hypervisor list, and it is bad for user experience to display
thousands of items in a table in horizon. This patch is proposed to
support pagination for hypervisor by adding `limit` and `marker` to
the list api.

Implements blueprint: pagination-for-hypervisor

Change-Id: Ie7f8b5c733b383f3e69fa23188e56257e503b5f7
2016-07-01 08:47:50 +08:00
Pavel Kholkin
ebe8fd945b api-ref: docs for microversion v2.28
Part of bp nova-api-hypervsor-cpu-info
Part of bp api-ref-in-rst

Change-Id: I48a5824c653825b9fdc6cd4d5a2f6ade03fff011
2016-06-21 17:40:06 +03:00
Kevin_Zheng
126400a1c9 api-ref: parameter verification for os-hypervisors
checked parameters

Part of bp:api-ref-in-rst

Change-Id: I6078a0ee0914f3c5cc92d9c17f0d19146f9d373b
2016-06-07 13:57:13 +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
5b9a51af72 Complete method Verification of os-hypervisors
verified the API doc for os-hypervisors,
added policy description as this is admin action by default,
Also, remove some common error code like 500, 503 etc

Part of bp:api-ref-in-rst

Change-Id: Ic81eac06cb238d0940feac41940433f9e3befc29
2016-04-25 19:58:53 +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
jichenjc
f03a3a5be4 Update 'os-hypervisors.inc' in api-ref
some changes including:
1) update the wrong reference link to json file
2) Add /v2.1/{tenant_id}/os-hypervisors/detail
3) Add /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/search
4) Add /v2.1/{tenant_id}/os-hypervisors/{hypervisor_id}/servers

Part of bp:api-ref-in-rst

Change-Id: I73fbf4583cd75afb2f60c57acd1bdb179f86a9e9
2016-03-24 02:42:03 +08: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
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