summaryrefslogtreecommitdiff
path: root/api-ref/source/os-hypervisors.inc
diff options
context:
space:
mode:
authorTakashi NATSUME <natsume.takashi@lab.ntt.co.jp>2017-01-05 18:40:52 +0900
committerTakashi NATSUME <natsume.takashi@lab.ntt.co.jp>2017-01-26 23:40:12 +0000
commit070656a4782508eb3c7a341a3dcf58266e783b6c (patch)
treeb72f51ea95248da58609c6293677aa8285a43866 /api-ref/source/os-hypervisors.inc
parentf9d7b383a7cb12b6cd3e6117daf69b08620bf40f (diff)
downloadnova-070656a4782508eb3c7a341a3dcf58266e783b6c.tar.gz
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
Diffstat (limited to 'api-ref/source/os-hypervisors.inc')
-rw-r--r--api-ref/source/os-hypervisors.inc13
1 files changed, 7 insertions, 6 deletions
diff --git a/api-ref/source/os-hypervisors.inc b/api-ref/source/os-hypervisors.inc
index c340c7f843..71c6814a4c 100644
--- a/api-ref/source/os-hypervisors.inc
+++ b/api-ref/source/os-hypervisors.inc
@@ -246,9 +246,9 @@ Response
Search Hypervisor
=================
-.. rest_method:: GET /os-hypervisors/{hypervisor_id}/search
+.. rest_method:: GET /os-hypervisors/{hypervisor_hostname_pattern}/search
-Search hypervisor by given hypervisor id.
+Search hypervisor by a given hypervisor host name or portion of it.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
@@ -263,7 +263,7 @@ Request
.. rest_parameters:: parameters.yaml
- - hypervisor_id: hypervisor_id
+ - hypervisor_hostname_pattern: hypervisor_hostname_pattern
Response
--------
@@ -284,9 +284,10 @@ Response
List Hypervisor Servers
=======================
-.. rest_method:: GET /os-hypervisors/{hypervisor_id}/servers
+.. rest_method:: GET /os-hypervisors/{hypervisor_hostname_pattern}/servers
-List all servers belong to given hypervisor.
+List all servers belong to each hypervisor whose host name is matching
+a given hypervisor host name or portion of it.
Policy defaults enable only users with the administrative role to perform
this operation. Cloud providers can change these permissions through
@@ -301,7 +302,7 @@ Request
.. rest_parameters:: parameters.yaml
- - hypervisor_id: hypervisor_id
+ - hypervisor_hostname_pattern: hypervisor_hostname_pattern
Response
--------