From c5950d63801eee2492c64620e1f51ac8846030a6 Mon Sep 17 00:00:00 2001 From: Marcus Olsson Date: Tue, 19 May 2020 09:05:38 +0200 Subject: [PATCH] Update plugin metadata (#24791) --- docs/sources/developers/plugins/metadata.md | 32 ++++++++++----------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/sources/developers/plugins/metadata.md b/docs/sources/developers/plugins/metadata.md index f81311d6ba3..0094abbde05 100644 --- a/docs/sources/developers/plugins/metadata.md +++ b/docs/sources/developers/plugins/metadata.md @@ -27,14 +27,14 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans | `category` | string | No | Plugin category used on the Add data source page. Possible values are: `tsdb`, `logging`, `cloud`, `tracing`, and `sql`. | | `executable` | string | No | The first part of the file name of the backend component executable. There can be multiple executables built for different operating system and architecture. Grafana will check for executables named `_<$GOOS>_<.exe for Windows>`, e.g. `plugin_linux_amd64`. Combination of $GOOS and $GOARCH can be found here: https://golang.org/doc/install/source#environment. | | `hiddenQueries` | boolean | No | | -| `includes` | [array](#includes) | No | | +| `includes` | [object](#includes)[] | No | | | `logs` | boolean | No | For data source plugins. If the plugin supports logs. | | `metrics` | boolean | No | For data source plugins. If the plugin supports metric queries. Used in the Explore feature. | | `mixed` | boolean | No | Not to be used by external plugins. Special property for the built-in mixed plugin. | | `module` | string | No | | | `partials` | [object](#partials) | No | | | `queryOptions` | [object](#queryoptions) | No | For data source plugins. There is a query options section in the plugin's query editor and these options can be turned on if needed. | -| `routes` | [array](#routes) | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/). | +| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/). | | `sort` | number | No | Internal property for sorting. Cannot be used as will be overwritten by Grafana. | | `staticRoot` | string | No | | | `streaming` | boolean | No | For data source plugins. If the plugin supports streaming. | @@ -47,10 +47,10 @@ Plugin dependencies. ### Properties -| Property | Type | Required | Description | -|------------------|-------------------|----------|------------------------------------------------------------------------------------------------------------------| -| `grafanaVersion` | string | **Yes** | Required Grafana version for this plugin, e.g. `6.x.x 7.x.x` to denote plugin requires Grafana v6.x.x or v7.x.x. | -| `plugins` | [array](#plugins) | No | An array of required plugins on which this plugin depends. | +| Property | Type | Required | Description | +|------------------|----------|----------|------------------------------------------------------------------------------------------------------------------| +| `grafanaVersion` | string | **Yes** | Required Grafana version for this plugin, e.g. `6.x.x 7.x.x` to denote plugin requires Grafana v6.x.x or v7.x.x. | +| `plugins` | string[] | No | An array of required plugins on which this plugin depends. | ## includes @@ -71,16 +71,16 @@ Metadata for the plugin. Some fields are used on the plugins page in Grafana and ### Properties -| Property | Type | Required | Description | -|---------------|-----------------------|----------|-------------------------------------------------------------------------------------------------------------------------------| -| `logos` | [object](#logos) | **Yes** | SVG images that are used as plugin icons. | -| `updated` | string | **Yes** | Date when this plugin was built. | -| `version` | string | **Yes** | Project version of this commit, e.g. `6.7.x`. | -| `author` | [object](#author) | No | Information about the plugin author. | -| `description` | string | No | Description of plugin. Used on the plugins page in Grafana and for search on grafana.com. | -| `keywords` | [array](#keywords) | No | Array of plugin keywords. Used for search on grafana.com. | -| `links` | [array](#links) | No | An array of link objects to be displayed on this plugin's project page in the form `{name: 'foo', url: 'http://example.com'}` | -| `screenshots` | [array](#screenshots) | No | An array of screenshot objects in the form `{name: 'bar', path: 'img/screenshot.png'}` | +| Property | Type | Required | Description | +|---------------|--------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------| +| `logos` | [object](#logos) | **Yes** | SVG images that are used as plugin icons. | +| `updated` | string | **Yes** | Date when this plugin was built. | +| `version` | string | **Yes** | Project version of this commit, e.g. `6.7.x`. | +| `author` | [object](#author) | No | Information about the plugin author. | +| `description` | string | No | Description of plugin. Used on the plugins page in Grafana and for search on grafana.com. | +| `keywords` | string[] | No | Array of plugin keywords. Used for search on grafana.com. | +| `links` | [object](#links)[] | No | An array of link objects to be displayed on this plugin's project page in the form `{name: 'foo', url: 'http://example.com'}` | +| `screenshots` | [object](#screenshots)[] | No | An array of screenshot objects in the form `{name: 'bar', path: 'img/screenshot.png'}` | ### author