ansible-collection-checkmk.general icon indicating copy to clipboard operation
ansible-collection-checkmk.general copied to clipboard

[FEED] Harmonize module parameters

Open robin-checkmk opened this issue 3 years ago • 2 comments

Please verify first that your feedback is not already reported here. If possible and useful provide additional information below. This is optional however.

Provide your feedback

We already digressed with the naming of module parameters, namely the name of the managed object in the below-mentioned modules. This issue serves as a ground for discussion and work tracker towards harmonization.

Component Name

  • service_group
  • tag_group
  • contact_group
  • etc.

Ansible Version

$ ansible --version
ansible [core 2.13.4]
  python version = 3.10.6 (main, Aug 10 2022, 11:40:04) [GCC 11.3.0]
  jinja version = 3.1.2
  libyaml = True

Collection Version

$ ansible-galaxy collection list
Collection        Version
----------------- -------
tribe29.checkmk   0.11.0 

Environment

Screenshots

Additional context

robin-checkmk avatar Oct 24 '22 06:10 robin-checkmk

Dear @robin-tribe29

There is a "host_name" field in host module. To be consistent, then this should be also changed to just 'name'

It's a design issue, which one should decide once and carry on through all modules then. One can also make this style decision for all group modules only. It will be then also consistent.

I do not mind to make changes if we all agree on name conventions.

Best, Michael

msekania avatar Oct 24 '22 18:10 msekania

@msekania thanks for the input. I will investigate some more and discuss this internally. This will take some time though, but I feel like it is not that urgent. For the open PRs, I am uncertain right now, if we should wait or not. I will have more to share at the end of next week.

robin-checkmk avatar Oct 27 '22 14:10 robin-checkmk

See the initial issue description for the current state of affairs. The group modules are clean since the last release. Currently looking into other modules, which might be inconsistent. I also added some development guidelines for this, currently to be found in the devel branch.

robin-checkmk avatar Dec 19 '22 14:12 robin-checkmk