grafana

Documentation

Index

• Variables
• type Client
  • func NewClient() *Client
  • func (c *Client) FindOrgBySlug(slug string) (*Organization, error)
  • func (c *Client) FindPluginVersions(pluginID string) ([]PluginVersion, error)
  • func (c *Client) ListPlugins() ([]*Plugin, error)
• type Link
• type Organization
• type Plugin
• type PluginVersion

Variables

var ErrOrganizationNotFound = errors.New("organization not found")

ErrOrganizationNotFound is returned when we couldn't find an organization with a given slug.

var ErrPrivateOrganization = errors.New("organization is private")

ErrPrivateOrganization is returned when an organization exists but hasn't published any plugins yet.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client provides operations to the grafana.com API.

func NewClient

func NewClient() *Client

NewClient returns a new Client.

func (*Client) FindOrgBySlug

func (c *Client) FindOrgBySlug(slug string) (*Organization, error)

FindOrgBySlug returns the organization with a given slug.

func (*Client) FindPluginVersions

func (c *Client) FindPluginVersions(pluginID string) ([]PluginVersion, error)

FindPluginVersions returns all published versions for a given plugin ID.

func (*Client) ListPlugins

func (c *Client) ListPlugins() ([]*Plugin, error)

type Link

type Link struct {
	Rel  string `json:"rel"`
	Href string `json:"href"`
}

type Organization

type Organization struct {
	ID   int64  `json:"id"`
	Name string `json:"name"`
	Slug string `json:"slug,omitempty"`
}

Organization maps to a Grafana.com organization.

type Plugin

type Plugin struct {
	ID      int64  `json:"id"`
	Name    string `json:"name"`
	Version string `json:"version"`
	Slug    string `json:"slug"`
	Links   []Link `json:"links"`
}

type PluginVersion

type PluginVersion struct {
	Version   string    `json:"version"`
	Commit    string    `json:"commit"`
	CreatedAt time.Time `json:"createdAt"`
	Downloads int       `json:"downloads"`
	URL       string    `json:"url"`
	Verified  bool      `json:"verified"`
}

PluginVersion contains information about a published plugin.