api

Documentation

Index

• type API
  • func ProvideApi(starService star.Service, dashboardService dashboards.DashboardService) *API
  • func (api *API) GetStars(c *contextmodel.ReqContext) response.Response
  • func (api *API) StarDashboard(c *contextmodel.ReqContext) response.Response
  • func (api *API) StarDashboardByUID(c *contextmodel.ReqContext) response.Response
  • func (api *API) UnstarDashboard(c *contextmodel.ReqContext) response.Response
  • func (api *API) UnstarDashboardByUID(c *contextmodel.ReqContext) response.Response
• type StarDashboardByUIDParams
• type StarDashboardParams
• type UnstarDashboardByUIDParams
• type UnstarDashboardParams

Types

type API

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

func ProvideApi

func ProvideApi(
	starService star.Service,
	dashboardService dashboards.DashboardService,
) *API

func (*API) GetStars

func (api *API) GetStars(c *contextmodel.ReqContext) response.Response

func (*API) StarDashboard

func (api *API) StarDashboard(c *contextmodel.ReqContext) response.Response

swagger:route POST /user/stars/dashboard/{dashboard_id} signed_in_user starDashboard

Star a dashboard.

Stars the given Dashboard for the actual user.

Deprecated: true

Responses: 200: okResponse 400: badRequestError 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*API) StarDashboardByUID

func (api *API) StarDashboardByUID(c *contextmodel.ReqContext) response.Response

swagger:route POST /user/stars/dashboard/uid/{dashboard_uid} signed_in_user starDashboardByUID

Star a dashboard.

Stars the given Dashboard for the actual user.

Responses: 200: okResponse 400: badRequestError 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*API) UnstarDashboard

func (api *API) UnstarDashboard(c *contextmodel.ReqContext) response.Response

swagger:route DELETE /user/stars/dashboard/{dashboard_id} signed_in_user unstarDashboard

Unstar a dashboard.

Deletes the starring of the given Dashboard for the actual user.

Deprecated: true

Please refer to the [new](#/signed_in_user/unstarDashboardByUID) API instead

Responses: 200: okResponse 400: badRequestError 401: unauthorisedError 403: forbiddenError 500: internalServerError

func (*API) UnstarDashboardByUID

func (api *API) UnstarDashboardByUID(c *contextmodel.ReqContext) response.Response

swagger:route DELETE /user/stars/dashboard/uid/{dashboard_uid} signed_in_user unstarDashboardByUID

Unstar a dashboard.

Deletes the starring of the given Dashboard for the actual user.

Responses: 200: okResponse 400: badRequestError 401: unauthorisedError 403: forbiddenError 500: internalServerError

type StarDashboardByUIDParams

type StarDashboardByUIDParams struct {
	// in:path
	// required:true
	DashboardUID string `json:"dashboard_uid"`
}

swagger:parameters starDashboardByUID

type StarDashboardParams

type StarDashboardParams struct {
	// in:path
	// required:true
	DashboardID string `json:"dashboard_id"`
}

swagger:parameters starDashboard

type UnstarDashboardByUIDParams

type UnstarDashboardByUIDParams struct {
	// in:path
	// required:true
	DashboardUID string `json:"dashboard_uid"`
}

swagger:parameters unstarDashboardByUID

type UnstarDashboardParams

type UnstarDashboardParams struct {
	// in:path
	// required:true
	DashboardID string `json:"dashboard_id"`
}

swagger:parameters unstarDashboard