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
This commit is contained in:
Takashi NATSUME 2017-01-05 18:40:52 +09:00
parent f9d7b383a7
commit 070656a478
2 changed files with 15 additions and 7 deletions

View File

@ -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
--------

View File

@ -127,12 +127,19 @@ host_status_body_in:
in: path
required: false
type: string
hypervisor_hostname_pattern:
description: |
The hypervisor host name or a portion of it.
The hypervisor hosts are selected with the host name matching this pattern.
in: path
required: true
type: string
hypervisor_id:
description: |
The ID of the hypervisor.
in: path
required: true
type: string
type: integer
image_id:
description: |
The UUID of the image.