API request to list resources should return only minimal data

Bug #1227431 reported by aeva black
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
High
Lucas Alvares Gomes

Bug Description

Requests to list top-level resources should return a "list of resources" with minimal identifying details, not a "set of resources" containing full details of every resource. This is both a UX and performance concern when returning very large numbers of resources in lists.

Chassis:
- uuid
- description

Node:
- uuid
- all four states
- instance_uuid

Port:
- uuid
- MAC address

aeva black (tenbrae)
Changed in ironic:
importance: Undecided → High
status: New → Triaged
Revision history for this message
aeva black (tenbrae) wrote :

We should do this the same way Nova v2 implements it, eg:
GET /v1/nodes -> list of nodes with minimal info,
GET /v1/nodes/details -> list of nodes with full details (what we return today, or possibly more),
GET /v1/nodes/{UUID} -> full details for the specified node (which we already do).

Changed in ironic:
assignee: nobody → Lucas Alvares Gomes (lucasagomes)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

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

Changed in ironic:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/47873
Committed: http://github.com/openstack/ironic/commit/3dd85586b6f45006d2c30b3335933fc8757da8a5
Submitter: Jenkins
Branch: master

commit 3dd85586b6f45006d2c30b3335933fc8757da8a5
Author: Lucas Alvares Gomes <email address hidden>
Date: Mon Sep 23 17:30:59 2013 +0100

    API GET to return only minimal data

    Requests to list top-level resources like nodes, chassis or ports will
    now return only a subset of it's attributes, a subresource called /detail
    could be used to get the full details of the resource. This changes
    is supposed to improve performance and UX, also, others OpenStack APIs
    already do it the same way so it's also about being consistent between
    other APIs.

    Change-Id: Ida45febf60e44d50e506f3680ab371e1027010c4
    Closes-Bug: #1227431

Changed in ironic:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
milestone: none → icehouse-1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ironic:
milestone: icehouse-1 → 2014.1
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.