Elaborate on the group_by install_status parameter of the inventory plugin to include information about the expected data type

[mrmibrown]

SUMMARY

Elaborate on the group_by install_status parameter of the inventory plugin to include information about the expected data type. This parameter is expecting a 'choice list' index(integer) but it is not explained clearly leading to situations where strings are passed resulting in invalid queries:

Invalid:

plugin: servicenow.itsm.now
columns:
  - install_status
group_by:
  install_status:
    includes:
      - Installed   # HERE

Valid:

plugin: servicenow.itsm.now
columns:
  - install_status
group_by:
  install_status:
    includes:
      - 1    # HERE

ISSUE TYPE

• Documentation Report

COMPONENT NAME

plugin

ANSIBLE VERSION

[Akasurde]

@mrmibrown Thanks for reporting this issue. Could you please check if #78 works for you and let us know?

[tadeboro]

I think updating examples is not enough in this case. It is an OK(ish) workaround for the time being, but we really need to do better. At a minimum, we should make sure that users can use display values in the filter specification. This will make sure the filter definition and the resulting group names at least somewhat match.

We have some work planned in this direction for collection already, so getting there should not be too problematic.

[Akasurde]

@tadeboro Thanks for the information.