openstack/cinder
Code Issues Proposed changes

api-ref: Clarify os-host GET behavior

Browse Source 
Getting all hosts returns every Cinder service host, regardless
of which service is running on the host. But getting a specific
host will fail if you try it for a host not running cinder-volume.

This looks to be the behavior from the beginning, but there was
nothing denoting this, causing errors and confusion for code that
thought it could get a host from the list, then get detailed info
about that host. The details return volume and snapshot counts,
so it really only makes sense for cinder-volume, so the code ends
up returning a 404 for anything else.

This API design seems a little disjointed, but since this is how
it appears to have always been, just make sure the api docs have
the right details for potential API consumers to know what to
expect.

Change-Id: If53279cfcbbde1297bb2e55e17d17b473e7d0d6e
Closes-bug: #1691144
This commit is contained in:
Sean McGinnis 2017-08-30 14:59:11 -05:00
parent 55e2934722
commit 86a96625d7
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
api-ref/source/v2/hosts.inc
View File

@ -49,7 +49,11 @@ Show Host Details
.. rest_method:: GET /v2/{admin_tenant_id}/os-hosts/{host_name}
Shows details for a host.
Shows volume and snapshot details for a cinder-volume host.
*Note:* This API is meant specifically for cinder-volume hosts only.
It is not valid against other Cinder service hosts or hosts where the
cinder-volume service has been disabled.
Normal response codes: 200

6
api-ref/source/v3/hosts.inc
View File

@ -49,7 +49,11 @@ Show Host Details for a project
.. rest_method:: GET /v3/{admin_project_id}/os-hosts/{host_name}
Shows details for a host.
Shows volume and snapshot details for a cinder-volume host.
*Note:* This API is meant specifically for cinder-volume hosts only.
It is not valid against other Cinder service hosts or hosts where the
cinder-volume service has been disabled.
Normal response codes: 200