Opensearch dashboards.pluginmanifest

PluginManifest interface

Describes the set of required and optional properties plugin can define in its mandatory JSON manifest file.

Signature:

export interface PluginManifest

Should never be used in code outside of Core but is exported for documentation purposes.

Property	Type	Description
configPath	ConfigPath	Root used by the plugin, defaults to "id" in snake_case format.
extraPublicDirs?	string[]	(Optional) Specifies directory names that can be imported by other ui-plugins built using the same instance of the @osd/optimizer. A temporary measure we plan to replace with better mechanisms for sharing static code between plugins
id	PluginName	Identifier of the plugin. Must be a string in camelCase. Part of a plugin public contract. Other plugins leverage it to access plugin API, navigate to the plugin, etc.
opensearchDashboardsVersion	string	The version of OpenSearch Dashboards the plugin is compatible with, defaults to "version".
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 string[]	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.
server	boolean	Specifies whether plugin includes some server-side specific functionality.
ui	boolean	Specifies whether plugin includes some client/browser specific functionality that should be included into client bundle via `public/ui_plugin.js` file.
version	string	Version of the plugin.