Remove Location header from createImage and createBackup responses

Registered by Matt Riedemann

This is explained in detail in bug 1679285, but the createImage API returns a Location header in the response which is built from the CONF.glance.api_servers configuration within Nova that is most likely using internal addresses for Glance, making it unusable for the end user.

Client code like Tempest and python-novaclient have always ignored the Location header in the response and just parsed the URL to get the image ID and use it for their own GET /v2/images/{image_id} request.

Also, the URL in the Location header response is unversioned, but reading the image service API reference docs for the versions document and the examples, there is always a versioned prefix on the URL, e.g. GET /v1/images or GET /v2/images. The fact the URL returned from nova is unversioned likely means this is a legacy artifact before Glance was split out from Nova.

This blueprint proposes to remove the Location header in the response and just return the image_id in a response body dict with a new microversion for the createImage API.

We have the same issue in the createBackup server action API too.

Blueprint information

Status:
Complete
Approver:
John Garbutt
Priority:
Medium
Drafter:
Matt Riedemann
Direction:
Approved
Assignee:
Matt Riedemann
Definition:
Approved
Series goal:
Accepted for pike
Implementation:
Implemented
Milestone target:
milestone icon pike-2
Started by
Matt Riedemann
Completed by
Matt Riedemann

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:bp/remove-create-image-location-header-response,n,z

Addressed by: https://review.openstack.org/452951
    Remove Location header from createImage and createBackup response (spec)

Addressed by: https://review.openstack.org/452970
    Document and provide useful error message for volume-backed backup

Addressed by: https://review.openstack.org/452971
    api-ref: move createBackup to server-actions

Addressed by: https://review.openstack.org/455443
    2.43: Remove Location header from createImage and createBackup responses

Gerrit topic: https://review.openstack.org/#q,topic:bug/1679285,n,z

Addressed by: https://review.openstack.org/457181
    Deprecate Multinic, floatingip action and os-virtual-interface API

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.