implicitly complex attributes should be documented better

Bug #1442528 reported by Pavlo Shchelokovskyy
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Triaged
Medium
Unassigned

Bug Description

In many places we have attributes that are almost verbatim constructed from the object returned by a given OpenStack API. These then allow deeper introspection via get_attr function, but the user has no clear indication on which OpenStack API to examine to find out what values can be extracted from such attribute.

Example: OS::Neutron::Pool has 'vip' attribute, that can be used to get the 'port_id' of that vip, although it is completely unclear for the user how/from where this 'port_id' appears as it is not present in the attribute schema presented by Heat.

We should at least document such attributes pointing user to what API schema of which OpenStack service (s)he should examine to find out possible values to use with get_attr on such attribute.

Angus Salkeld (asalkeld)
Changed in heat:
status: New → Triaged
importance: Undecided → High
Anant Patil (ananta)
Changed in heat:
assignee: nobody → Anant Patil (ananta)
Anant Patil (ananta)
Changed in heat:
assignee: Anant Patil (ananta) → nobody
Changed in heat:
importance: High → Medium
Rico Lin (rico-lin)
Changed in heat:
milestone: none → no-priority-tag-bugs
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.