Skip to content

N
nexpie-grafana-theme
Commit 338943d3 by Marcus Olsson Committed by GitHub
Options

Add skipDataQuery to plugin.json schema (#26940) 

* Add skipDataQuery to plugin.json schema

* Fix typo
parent be3bf807
Showing with 8 additions and 2 deletions
docs/sources/developers/plugins/metadata.md
...@@ -35,6 +35,7 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans ...@@ -35,6 +35,7 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans
| `partials` | [object](#partials) | 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. | | `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/). | | `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. | | `sort` | number | No | Internal property for sorting. Cannot be used as will be overwritten by Grafana. |
| `staticRoot` | string | No | | | `staticRoot` | string | No | |
| `streaming` | boolean | No | For data source plugins. If the plugin supports streaming. | | `streaming` | boolean | No | For data source plugins. If the plugin supports streaming. |
...@@ -49,7 +50,7 @@ Plugin dependencies. ...@@ -49,7 +50,7 @@ Plugin dependencies.
| Property | Type | Required | Description | | 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. | | `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. | | `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. ...@@ -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. | | `grant_type` | string | No | For data source plugins. OAuth grant type. |
| `resource` | string | No | For data source plugins. OAuth resource. | | `resource` | string | No | For data source plugins. OAuth resource. |
docs/sources/developers/plugins/plugin.schema.json
...@@ -73,6 +73,10 @@ ...@@ -73,6 +73,10 @@
"type": "boolean", "type": "boolean",
"description": "For data source plugins. If the plugin supports logs." "description": "For data source plugins. If the plugin supports logs."
}, },
"skipDataQuery": {
"type": "boolean",
"description": "For panel plugins. Hides the query editor."
},
"partials": { "partials": {
"type": "object", "type": "object",
"additionalItems": false, "additionalItems": false,
...@@ -127,7 +131,7 @@ ...@@ -127,7 +131,7 @@
}, },
"grafanaDependency": { "grafanaDependency": {
"type": "string", "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])?$" "pattern": "^(>=|<|>|<=)?([0-9]+)(\\.[0-9]+)?(\\.[0-9])?$"
}, },
"plugins": { "plugins": {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment