From 338943d349be16e9a6ae8f959dc135bddad15571 Mon Sep 17 00:00:00 2001 From: Marcus Olsson Date: Mon, 17 Aug 2020 11:31:25 +0200 Subject: [PATCH] Add skipDataQuery to plugin.json schema (#26940) * Add skipDataQuery to plugin.json schema * Fix typo --- docs/sources/developers/plugins/metadata.md | 4 +++- docs/sources/developers/plugins/plugin.schema.json | 6 +++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/sources/developers/plugins/metadata.md b/docs/sources/developers/plugins/metadata.md index 379d45f4589e2..664e1b2064178 100644 --- a/docs/sources/developers/plugins/metadata.md +++ b/docs/sources/developers/plugins/metadata.md @@ -35,6 +35,7 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans | `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` | [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/). | +| `skipDataQuery` | boolean | No | For panel plugins. Hides the query editor. | | `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. | @@ -49,7 +50,7 @@ Plugin dependencies. | Property | Type | Required | Description | |---------------------|----------|----------|-------------------------------------------------------------------------------------------------------------------------------| -| `grafanaDependency` | string | **Yes** | Required Grafana version for this plugin, e.g. `>=7.0.0` to denote plugin requires Grafana 7.0.0 or later. | +| `grafanaDependency` | string | **Yes** | Required Grafana version for this plugin, e.g. `>=7.0.0` to denote plugin requires Grafana 7.0.0 or later. | | `grafanaVersion` | string | No | (Deprecated) 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. | @@ -184,3 +185,4 @@ For data source plugins. Parameters for the token authentication request. | `grant_type` | string | No | For data source plugins. OAuth grant type. | | `resource` | string | No | For data source plugins. OAuth resource. | + diff --git a/docs/sources/developers/plugins/plugin.schema.json b/docs/sources/developers/plugins/plugin.schema.json index 75d56223c7a4a..aaab12b818632 100644 --- a/docs/sources/developers/plugins/plugin.schema.json +++ b/docs/sources/developers/plugins/plugin.schema.json @@ -73,6 +73,10 @@ "type": "boolean", "description": "For data source plugins. If the plugin supports logs." }, + "skipDataQuery": { + "type": "boolean", + "description": "For panel plugins. Hides the query editor." + }, "partials": { "type": "object", "additionalItems": false, @@ -127,7 +131,7 @@ }, "grafanaDependency": { "type": "string", - "description": "Required Grafana version for this plugin, e.g. `>=7.0.0` to denote plugin requires Grafana 7.0.0 or later", + "description": "Required Grafana version for this plugin, e.g. `>=7.0.0` to denote plugin requires Grafana 7.0.0 or later.", "pattern": "^(>=|<|>|<=)?([0-9]+)(\\.[0-9]+)?(\\.[0-9])?$" }, "plugins": {