API reference doesn't cover several APIs of Compute and BlockStorage called from python client and/or defcore testcase

[Toshikazu Ichikawa]

We noticed that the following APIs are not shown in API reference while we were using python client and Defcore test set.
We believe these should be covered by OpenStack API reference.

---

Compute API v2 extensions:

 PUT v2/[ID]/servers/[ID]/os-volume_attachments/[ID]

 GET v2/[ID]/os-availability-zone
 GET v2/[ID]/os-availability-zone/detail
(Potentially, the existing description may be just missing a [ID] part in the path.)

 GET v2/[ID]/os-quota-sets/[ID]/defaults
(Potentially, the existing description may be just missing a [ID] part in the path.)

 POST v2/[ID]/os-security-group-rules
(In the reference, we have “POST /v2/{tenant_id}/os-security-group-default-rules” but it’s a different path.)

 POST v2/[ID]/os-volumes
(In the reference, we have “POST /v1.1/{tenant_id}/os-volumes/{volume_id}” but it’s a different path of version.)

BlockStorageAPIv2.0:

 POST v2/[ID]/volumes/[ID]/metadata
 PUT v2/[ID]/volumes/[ID]/metadata

 GET v2/[ID]/os-availability-zone

 POST v2/[ID]/os-volume-transfer
 DELETE v2/[ID]/os-volume-transfer/[ID]
 GET v2/[ID]/os-volume-transfer/[ID]
 POST v2/[ID]/os-volume-transfer/[ID]/accept
 GET v2/[ID]/os-volume-transfer/detail

BlockStrageAPIv2.0 Extentions:

 POST v2/{tenant_id}/volumes/{volume_id}/action

end of list.

[Anne Gentle (annegentle)]

Make sure you are looking on the extensions page for Compute v2. For example:
http://developer.openstack.org/api-ref-compute-v2-ext.html#os-flavor-extra-specs

http://developer.openstack.org/api-ref-compute-v2-ext.html#os-volume_attachments

http://developer.openstack.org/api-ref-compute-v2-ext.html#os-availability-zone

[Toshikazu Ichikawa (ichikawa-toshikazu)]

We have checked the extensions page for Compute v2 and updated this bug report.

We could find the following so they are removed from this report.
GET v2/[ID]/flavors/[ID]/os-extra_specs
DELETE v2/[ID]/servers/[ID]/os-server-password
GET v2/[ID]/servers/[ID]/os-server-password
POST v2/[ID]/os-volumes_boot
GET v2/[ID]/os-quota-sets/[ID]/defaults

As for os-volume_attachments API, we couldn’t find “PUT” method even though the others such as GET are in the reference.

As for os-availability-zone API, “GET v2/os-availability-zone” is in the reference. However “GET v2/[ID]/os-availability-zone” is missing. Both may be needed or the existing one may be needed to be modified.

So please re-evaluate this report which I’ve updated.

[Diane Fleming (diane-fleming)]

There is not GET v2/{id}/os-availability_zone call. The correct call is:

http://developer.openstack.org/api-ref-compute-v2-ext.html#getVolumeAttachmentDetails

/v2/​{tenant_id}​/servers/​{server_id}​/os-volume_attachments/​{attachment_id}​ -> the "id" is after the os-volume_attachments resource.

I believe you are correct about the os-availability-zone call -

http://developer.openstack.org/api-ref-compute-v2-ext.html#getAvailabilityZone

It is missing the "id" in the call. I'll fix that.

[Diane Fleming (diane-fleming)]

Set and unset metadata are these calls:

http://developer.openstack.org/api-ref-blockstorage-v2.html#setVolumeimagemetadata

http://developer.openstack.org/api-ref-blockstorage-v2.html#unsetVolumeimagemetadata

[Diane Fleming (diane-fleming)]

The volume actions calls are here:

http://developer.openstack.org/api-ref-blockstorage-v2.html#volume-api-v2-volumes-actions

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/215230

[Diane Fleming (diane-fleming)]

https://review.openstack.org/215230

[Toshikazu Ichikawa (ichikawa-toshikazu)]

As for #6, I found it's missing 'os-volume_upload_image' action. (I should have noted.)
The action is in this document, https://wiki.openstack.org/wiki/CreateVolumeFromImage#Code_Changes.
I think it's should be added/fixed as well.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/215230
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=ad7809c3d587c0395beb05d4995b3a1ca1b387db
Submitter: Jenkins
Branch: master

commit ad7809c3d587c0395beb05d4995b3a1ca1b387db
Author: Diane Fleming <email address hidden>
Date: Thu Aug 20 11:35:48 2015 -0500

    Clean up Compute v2 extensions

    os-availability-zone extension was missing a call and incorrectly
    described the "GET" calls
    os-availability-zone extension had unsupported XML examples
    os-quota-sets "defaults" resource was in wrong place
    os-volume updated to show v2 rather than v1.1

    Change-Id: I0b296b07358ac69cc733d09b267d7a829f33197d
    Closes-Bug: #1485818