metadata

Documentation

Index

• Variables
• type Author
• type Includes
• type Info
• type Link
• type Logos
• type Metadata
• type MetadataDependencies
• type MetadataPluginDependency
• type Screenshots

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "metadata",
	Requires: []*analysis.Analyzer{archive.Analyzer},
	Run:      run,
	Rules:    []*analysis.Rule{missingMetadata},
	ReadmeInfo: analysis.ReadmeInfo{
		Name:        "Metadata",
		Description: "Checks that `plugin.json` exists and is valid.",
	},
}

Types

type Author

type Author struct {
	URL string `json:"url"`
}

type Includes

type Includes struct {
	Action     string `json:"action"`
	AddToNav   bool   `json:"addToNav"`
	Component  string `json:"component"`
	DefaultNav bool   `json:"defaultNav"`
	Icon       string `json:"icon"`
	Name       string `json:"name"`
	Path       string `json:"path"`
	Role       string `json:"role"`
	Type       string `json:"type"`
	Uid        string `json:"uid"`
}

type Info

type Info struct {
	Author      Author        `json:"author"`
	Screenshots []Screenshots `json:"screenshots"`
	Logos       Logos         `json:"logos"`
	Links       []Link        `json:"links"`
	Version     string        `json:"version"`
	Keywords    []string      `json:"keywords"`
	Description string        `json:"description"`
}

type Link

type Link struct {
	Name string `json:"name"`
	URL  string `json:"url"`
}

type Logos

type Logos struct {
	Small string `json:"small"`
	Large string `json:"large"`
}

type Metadata

type Metadata struct {
	ID           string               `json:"id"`
	Name         string               `json:"name"`
	Type         string               `json:"type"`
	Info         Info                 `json:"info"`
	Includes     []Includes           `json:"includes"`
	Executable   string               `json:"executable"`
	Backend      bool                 `json:"backend"`
	Alerting     bool                 `json:"alerting"`
	Dependencies MetadataDependencies `json:"dependencies"`
}

type MetadataDependencies

type MetadataDependencies struct {
	GrafanaDependency string                     `json:"grafanaDependency"`
	Plugins           []MetadataPluginDependency `json:"plugins"`
}

type MetadataPluginDependency

type MetadataPluginDependency struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Type    string `json:"type"`
	Version string `json:"version"`
}

type Screenshots

type Screenshots struct {
	Name string `json:"name"`
	Path string `json:"path"`
}