Skip to content

Docs: Sync metadata.md with latest plugin.schema.json #2582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mckn merged 1 commit into from
Apr 16, 2026
Merged

Docs: Sync metadata.md with latest plugin.schema.json #2582

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docusaurus/docs/reference/metadata.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The `plugin.json` file is required for all plugins. When Grafana starts, it scan
| [**includes**](#includes) | `object[]` | Resources to include in plugin.<br/> | |
| **logs** | `boolean` | For data source plugins, if the plugin supports logs. It may be used to filter logs only features.<br/> | |
| **metrics** | `boolean` | For data source plugins, if the plugin supports metric queries. Used to enable the plugin in the panel editor.<br/> | |
| **multiValueFilterOperators** | `boolean` | For data source plugins, if the plugin supports multi value operators in adhoc filters.<br/> | |
| **multiValueFilterOperators** | `boolean` | For data source plugins, if the plugin supports multi value operators in filters.<br/> | |
| **pascalName** | `string` | [internal only] The PascalCase name for the plugin. Used for creating machine-friendly identifiers, typically in code generation. If not provided, defaults to name, but title-cased and sanitized (only alphabetical characters allowed).<br/>Pattern: `^([A-Z][a-zA-Z]{1,62})$`<br/> | |
| **preload** | `boolean` | Initialize plugin on startup. By default, the plugin initializes on first use, but when preload is set to true the plugin loads when the Grafana web app loads the first time. Only applicable to app plugins. When setting to `true`, implement [frontend code splitting](https://grafana.com/developers/plugin-tools/get-started/best-practices#app-plugins) to minimise performance implications.<br/> | |
| **suggestions** | `boolean` | For panel plugins. If set to true, the plugin's suggestions supplier will be invoked and any suggestions returned will be included in the Suggestions pane in the Panel Editor.<br/> | |
Expand Down
Loading