IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

plugin.json schema updates (#27029)

Browse Source 
* added $schema field support in plugin.schema.json

More details can be found in https://github.com/grafana/plugin-validator/issues/1

* Others category in plugin.json, minimum 1 keyword 

* Allow others as a category if the plugin doesn't fall into appropriate category. Refer https://github.com/grafana/plugin-validator/issues/3 for more details
* Mandate minimum one keyword for better discovery in plugin repository.

* Dropped enum from plugin.json $schema
This commit is contained in:
Sriramajeyam Sugumaran 2020-08-19 20:27:44 +01:00 committed by GitHub
parent b4289a48f1
commit 98f8ec7c89
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/sources/developers/plugins/plugin.schema.json
View File

@ -7,6 +7,10 @@
"required": ["type", "name", "id", "info", "dependencies"], "required": ["type", "name", "id", "info", "dependencies"],
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"$schema": {
"type": "string",
"description": "Schema definition for the plugin.json file"
},
"id": { "id": {
"type": "string", "type": "string",
"description": "Unique name of the plugin. If the plugin is published on grafana.com, then the plugin id has to follow the naming conventions.", "description": "Unique name of the plugin. If the plugin is published on grafana.com, then the plugin id has to follow the naming conventions.",
@ -23,8 +27,8 @@
}, },
"category": { "category": {
"type": "string", "type": "string",
"description": "Plugin category used on the Add data source page. Possible values are: `tsdb`, `logging`, `cloud`, `tracing`, and `sql`.", "description": "Plugin category used on the Add data source page. Possible values are: `tsdb`, `logging`, `cloud`, `tracing`, `sql`, `enterprise` and `other`.",
"enum": ["tsdb", "logging", "cloud", "tracing", "sql"] "enum": ["tsdb", "logging", "cloud", "tracing", "sql", "enterprise", "other"]
}, },
"annotations": { "annotations": {
"type": "boolean", "type": "boolean",
@ -146,7 +150,7 @@
"info": { "info": {
"type": "object", "type": "object",
"description": "Metadata for the plugin. Some fields are used on the plugins page in Grafana and others on grafana.com if the plugin is published.", "description": "Metadata for the plugin. Some fields are used on the plugins page in Grafana and others on grafana.com if the plugin is published.",
"required": ["logos", "version", "updated"], "required": ["logos", "version", "updated", "keywords"],
"additionalProperties": false, "additionalProperties": false,
"properties": { "properties": {
"author": { "author": {
@ -177,6 +181,7 @@
"keywords": { "keywords": {
"type": "array", "type": "array",
"description": "Array of plugin keywords. Used for search on grafana.com.", "description": "Array of plugin keywords. Used for search on grafana.com.",
"minItems": 1,
"items": { "items": {
"type": "string" "type": "string"
} }