Today i write here to hopefully get something solved i struggle for some month.
I’m developing several agentbased plugins for checkmk and additionally converting them now to the new check-, bakery- and rulesets-APIs. Very often i miss some information in the docs especially if it comes to some enumeration classes.
As an example i take the class Topic from rulesets.v1.rule_specs
We all know, that this class is used as an enumeration and hase members like GENERAL, APPLICATIONS or WINDOWS. But i don’t know anything about other members. The documentation lacks any information on this. Even the known members are not listet in the docs.
This is the case not only for the class Topic but for all other enumerations in the APIs.
I’m tired of greping the source-code to find anything useful, so perhaps you can extend the documentations to giving some informations on enum-members. That would be really nice and helpful.
The (Plugin-) docs do not list available options implemented, which should be listed.
It makes it hard for someone to figure out what is there, and apply it.
It’s possible, but a per-enum effort. I don’t think we should add this to all enums, though. Adding all 81 members for Color for example might be a little much? It also depends how the collapsing behaves.
Anyway, since it is a per-enum effort: Which are the most important ones to you?
This is for me the most used - and most asked/discussed in this forum as my search showed up.
I did hope that the documentation tool you use would fill in all enum members automatically (naturaly without descriptive words) by setting a flag or something like this.
Well, not exactly a flag, but I managed to add all the enums. Here you go. I am not sure how often the online version updates, but it will show up eventually.
.