API v1.1 Response Document Changes

Registered by Kurt Griffiths on 2014-02-07

--*-- The partial field is no longer included in responses to a message posting request.
--*-- When a collection resource is requested (i.e., queues, messages) and the collection is empty, an empty JSON array is now returned in the response body, rather than HTTP 204 No Content.
--*-- All top-level JSON arrays in response bodies are now encapsulated within an object.
--*-- Extraneous path elements from relative URIs were removed
--*-- A claim field has been added to messages. It is null if the message is not claimed.
--*-- An id field has been added to messages
--*-- Message href's now always include claim_id in the query string if the message is claimed.

Blueprint information

Status:
Complete
Approver:
Flavio Percoco
Priority:
High
Drafter:
Kurt Griffiths
Direction:
Needs approval
Assignee:
Nataliia Uvarova
Definition:
Approved
Series goal:
Accepted for juno
Implementation:
Implemented
Milestone target:
milestone icon 2014.2
Started by
Flavio Percoco on 2014-08-19
Completed by
Flavio Percoco on 2014-09-12

Related branches

Sprints

Whiteboard

Moving to j-2 (kgriffs)

Gerrit topic: https://review.openstack.org/#q,topic:bp/api-v1,n,z

Addressed by: https://review.openstack.org/109391
    Deprecate partial field in v1.0, remove in v1.1

Kurt, is this something we still want for Juno? Do you have some info about this?
-- flaper87 2014-08-08

Addressed by: https://review.openstack.org/116926
    API v1.1: adding id field to messages

FFE Granted: http://lists.openstack.org/pipermail/openstack-dev/2014-September/044954.html
-- flaper87 2014-09-05

Addressed by: https://review.openstack.org/119347
    V1.1: Add claim_id to message url

Addressed by: https://review.openstack.org/121133
    V1.1: Add id property to messages in claims

(?)

Work Items

Work items:
The partial field is no longer included in responses to a message posting request: DONE
When a collection resource is requested (i.e., queues, messages) and the collection is empty, an empty JSON array is turned in the response body, rather than HTTP 204 No Content: DONE
All top-level JSON arrays in response bodies are now encapsulated within an object: DONE
Extraneous path elements from relative URIs were removed: TODO
A claim field has been added to messages. It is null if the message is not claimed: DONE
An id field has been added to messages: DONE
Message href's now always include claim_id in the query string if the message is claimed: DONE

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.