include info about multilevel restricted JSON pointers

Bug #1253672 reported by Brian Rosmaita
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Glance
Triaged
Low
Unassigned

Bug Description

The Havana release of Glance introduces a "multiple image locations" option. In order to allow the http PATCH (image-update) request to operate on multiple locations, the "restricted JSON pointers" used by the application/openstack-images-v2.1-json-patch media type has been expanded to allow multilevel references.

(1) The documentation in the OpenStack Image Service API v2 Reference needs to be updated to reflect this.

(2) Need to supply at least one example, either in Appendix B or in the image update section, illustrating how to use the multilevel pointer to update an image location.

(3) Judgement call: update the image detail section to show what an image response looks like with multiple image locations turned on.

Tom Fifield (fifieldt)
Changed in openstack-api-site:
milestone: none → havana
status: New → Triaged
importance: Undecided → Medium
Tom Fifield (fifieldt)
tags: added: havana image-api
Changed in openstack-api-site:
milestone: havana → none
Revision history for this message
Anne Gentle (annegentle) wrote :

This file is now published to http://specs.openstack.org/openstack/glance-specs/specs/api/v2/http-patch-image-api-v2.html and the source is in glance-specs/specs/api/v2/http-patch-image-api-v2.rst

Atsushi SAKAI (sakaia)
Changed in openstack-api-site:
assignee: nobody → Atsushi SAKAI (sakaia)
Atsushi SAKAI (sakaia)
affects: openstack-api-site → glance
Revision history for this message
Brian Rosmaita (brian-rosmaita) wrote :

There's an example in the docs located at glance-specs/specs/api/v2/http-patch-image-api-v2.rst , but that page could probably use some clarification.

summary: - update Images v2 API to include info about multilevel restricted JSON
- pointers
+ include info about multilevel restricted JSON pointers
Changed in glance:
assignee: Atsushi SAKAI (sakaia) → nobody
importance: Medium → Low
tags: added: documentation low-hanging-fruit
removed: havana image-api
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.