api

Documentation

Index

• func CountPublicDashboardRequest() func(c *models.ReqContext)
• func RequiresValidAccessToken(publicDashboardService publicdashboards.Service) func(c *models.ReqContext)
• func SetPublicDashboardFlag() func(c *models.ReqContext)
• type Api
  • func ProvideApi(pd publicdashboards.Service, rr routing.RouteRegister, ...) *Api
  • func (api *Api) GetPublicDashboard(c *models.ReqContext) response.Response
  • func (api *Api) GetPublicDashboardConfig(c *models.ReqContext) response.Response
  • func (api *Api) QueryPublicDashboard(c *models.ReqContext) response.Response
  • func (api *Api) RegisterAPIEndpoints()
  • func (api *Api) SavePublicDashboardConfig(c *models.ReqContext) response.Response

Functions

func CountPublicDashboardRequest

func CountPublicDashboardRequest() func(c *models.ReqContext)

func RequiresValidAccessToken

func RequiresValidAccessToken(publicDashboardService publicdashboards.Service) func(c *models.ReqContext)

func SetPublicDashboardFlag

func SetPublicDashboardFlag() func(c *models.ReqContext)

Types

type Api

type Api struct {
	PublicDashboardService publicdashboards.Service
	RouteRegister          routing.RouteRegister
	AccessControl          accesscontrol.AccessControl
	Features               *featuremgmt.FeatureManager
	Log                    log.Logger
}

func ProvideApi

func ProvideApi(
	pd publicdashboards.Service,
	rr routing.RouteRegister,
	ac accesscontrol.AccessControl,
	features *featuremgmt.FeatureManager,
) *Api

func (*Api) GetPublicDashboard

func (api *Api) GetPublicDashboard(c *models.ReqContext) response.Response

Gets public dashboard GET /api/public/dashboards/:accessToken

func (*Api) GetPublicDashboardConfig

func (api *Api) GetPublicDashboardConfig(c *models.ReqContext) response.Response

Gets public dashboard configuration for dashboard GET /api/dashboards/uid/:uid/public-config

func (*Api) QueryPublicDashboard

func (api *Api) QueryPublicDashboard(c *models.ReqContext) response.Response

QueryPublicDashboard returns all results for a given panel on a public dashboard POST /api/public/dashboard/:accessToken/panels/:panelId/query

func (*Api) RegisterAPIEndpoints

func (api *Api) RegisterAPIEndpoints()

Registers Endpoints on Grafana Router

func (*Api) SavePublicDashboardConfig

func (api *Api) SavePublicDashboardConfig(c *models.ReqContext) response.Response

Sets public dashboard configuration for dashboard POST /api/dashboards/uid/:uid/public-config