[openstack-dev] New API guideline accepted for Collection Resources

Everett Toews everett.toews at RACKSPACE.COM
Wed Jan 21 22:18:41 UTC 2015

I’d like to announce that a new API guideline has been accepted for Collection Resources.


"JSON request and response representations for collection resources should be an object that includes a top-level property to encapsulate the collection of resources. The value of this property should be a JSON array whose elements are the JSON representations of the resources in the collection…”

The patch that introduced the API guideline is here


If you are creating a new API or a new version of an API, we encourage you to follow this guideline for Collection Resources. If you have such a patch coming up for review, you can use the APIImpact (as discussed in GitCommitMessages [1]) for better discoverability.


[1] https://wiki.openstack.org/wiki/GitCommitMessages#Including_external_references

More information about the OpenStack-dev mailing list