Allow config.set() with a custom config to define user-facing description text shown in Advanced Settings

[tsullivan]

It looks like when I have a plugin that calls config.set(CONFIG_NAME, value) to dynamically add a config value to store in the .kibana index, there is no way to add a description for this settings.

Built-in config options have a way to set a description. It would be great if this was possible for custom config settings as well.

Illustration:

cc @skearns64

[spalger]

I think being able to define your configs is reasonable, but I really don't think it should be a part of the config.get() API. All of the uiSettings are calculated server-side and the custom plugin definitions (with things like types, descriptions, and defaults) should go there.

[tsullivan]

@spalger is it possible to define configs for Advanced Settings from a plugin today?

…

On Mar 22, 2017, at 6:33 PM, Spencer ***@***.***> wrote: I think being able to define your configs is reasonable, but I really don't think it should be a part of the config.get() API. All of the uiSettings are calculated server-side and the custom plugin definitions (with things like types, descriptions, and defaults) should go there. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[spalger]

Nope, unfortunately it is not possible today.

[tsullivan]

I agree with the approach you described. Does this issue need to stay open, or is it a known part of config re-architecture?

[spalger]

This should definitely stay open. The platform work we're doing doesn't address this need. Might as well implement it in the current system if it's something you'd like to see soon.

[xycloud]

awesome feature,+1

[andrewkcarter]

I would really like to see it too. Also, the ability to provide the type for the value, i.e json.

[tsullivan]

It should be possible for a plugin to define its UI Settings in the uiExports block of a plugin definition.