Red Hat Bugzilla – Bug 1290359
Inconsistency in 'friendly name' field name for Operating System via CLI/API/UI
Last modified: 2017-03-30 14:36:47 EDT
Description of problem:
'Friendly name' field (which is name + major version + minor version) for Operating System is called, documented and acts differently for each interface (UI/CLI/API).
For UI, list of OSs is shown under 'Title' column. When you open any OS - there's no 'Title' field to change. There's 'Description' field instead, which is empty by default (meaning that's another field actually), but changing that description actually changes OS title.
Next, for CLI, 'hammer os create' command accepts '--description' (not --title) option. However, 'hammer os info' accepts and returns --title instead. Other commands like 'hammer medium add-operatingsystem' work with OS title, not description, too.
For API, apidoc contains no information about 'title' field, there's only 'description'. However, when you try to GET any custom OS, you'll see 'title' in output, which is representing OS friendly name, and 'description' field too, which is set to null by default.
Looks like there was no clear agreement on how the field should be called - in some places it's 'title', in others its 'description'. Both fields share same purpose so one of them (preferably 'description') should be dropped in favor of another.
Version-Release number of selected component (if applicable):
Steps to Reproduce:
1. Create Operating system (via UI/CLI/API, doesn't matter), do not specify anything in 'title'/'description' field.
2. Check 'title'/'description' via UI/CLI/API.
See 'Description of problem'
Leave only 'title' field for all three interfaces.
Moving 6.2 bugs out to sat-backlog.
Thank you for your bug report. Given our other priorities, I do not see us addressing this in the next few releases. I am therefore closing this out. If you feel that this is a mistake, please feel free to re-open with additional information. Thank you for your interest in Red Hat Satellite.