Skip to content

Opensearch dashboards.discoveredplugin

Home > opensearch-dashboards > DiscoveredPlugin

DiscoveredPlugin interface

Small container object used to expose information about discovered plugins that may or may not have been started.

Signature:

export interface DiscoveredPlugin 

Properties

Property Type Description
configPath ConfigPath Root configuration path used by the plugin, defaults to "id" in snake_case format.
id PluginName Identifier of the plugin.
optionalPlugins readonly PluginName[] An optional list of the other plugins that if installed and enabled **may be** leveraged by this plugin for some additional functionality but otherwise are not required for this plugin to work properly.
requiredBundles readonly PluginName[] List of plugin ids that this plugin's UI code imports modules from that are not in requiredPlugins.
requiredPlugins readonly PluginName[] An optional list of the other plugins that **must be** installed and enabled for this plugin to function properly.