table column headers/labels are inconsistent

Bug #1675041 reported by Ruby Loo
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
python-ironicclient
Opinion
Low
Unassigned

Bug Description

When outputting tables, the labels for the column headings have inconsistent formatting.

A quick look some OSC (compute) commands show that the labels all have the first letter of each word uppercased. We should probably do the same. Bonus points -- if someone verifies with OSC that this is true.

To check: whether it is OK to change existing labels.

Might be worth adding a unit test that checks for this.

For example (from [1]):

  'attach': 'Response is attachment',
  'hosts': 'Active host(s)',

vs

  'console_enabled': 'Console Enabled',
  'created_at': 'Created At',

[1] https://github.com/openstack/python-ironicclient/blob/2a711cd726b2d23903decf3f3adef92b15295dfc/ironicclient/v1/resource_fields.py#L36

M V P Nitesh (m-nitesh)
Changed in python-ironicclient:
assignee: nobody → M V P Nitesh (m-nitesh)
Revision history for this message
Vladyslav Drok (vdrok) wrote :

I think it's better not to change the existing labels without serious reason, as one can be using them to filter the output.

M V P Nitesh (m-nitesh)
Changed in python-ironicclient:
assignee: M V P Nitesh (m-nitesh) → nobody
Revision history for this message
Vladyslav Drok (vdrok) wrote :

So, here are the commands that can be used:

$ openstack baremetal node list -c 'Instance UUID'

which will work fine, but e.g.

$ openstack baremetal node list -c 'Instance UUId'

will not. Personally, I think it is not worth adding a bunch of deprecation stuff to capitalize the letters.

Revision history for this message
Dmitry Tantsur (divius) wrote :

Unfortunately, due to the reasons Vlad mentions we should not do it :( Sigh, let's be careful from now on.

Or maybe we need microversions for the client? ;)

Changed in python-ironicclient:
status: Confirmed → Opinion
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.