Heat GET /stacks call doesn't have a "detail" option

[Gabriel Hurley]

In other projects (Nova, Cinder, etc.) there is an option on the "list" operations to get a "detail" version of the response which contains all the available information about the resources being returned. For Nova this looks like GET /instances/detail.

This functionality is somewhere between extremely helpful and downright necessary in order to build a useful dashboard interface for Heat stacks, and currently requires either making the "list" view practically useless or being terribly inefficient and looping through each stack to fetch the detailed data for it before returning the list.

[Pavan (pavan0591)]

I can take this up!

Doesn't heat describe < stack name > give the details of the stack?

[Steve Baker (steve-stevebaker)]

heat/api/openstack/v1/stacks.py

format_stack is called with some filtering keys in index(), but with no filtering in show()

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/35034
Committed: http://github.com/openstack/heat/commit/016133f538fd4136006e996d8a9da9130a29c85c
Submitter: Jenkins
Branch: master

commit 016133f538fd4136006e996d8a9da9130a29c85c
Author: Liang Chen <email address hidden>
Date: Fri Jun 28 22:27:59 2013 +0800

    add GET /{tenant_id}/stacks/detail to Heat API

    Enables the building of a useful dashboard interface for Heat stacks
    without looping through stacks returned from "/{tenant_id}/stacks/"
    to fetch the detailed data.

    Fixes bug #1191117

    Change-Id: I06b1100873de462c69302e43259df13104cad79f

[Zane Bitter (zaneb)]

Using this path is a bit problematic... we use /{tenant_id}/stacks/{stack_name} to look up the ID for a stack, so if a user ever creates a stack called "details", then they won't be able to access it by name. (This scheme works for Nova because only UUIDs ever appear in that path segment, so there is no namespace conflict.)

IMO the correct thing to do here is to use a query parameter, e.g.:

  /{tenant_id}/stacks?detail=all