api

package
v4.0.2+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 8, 2016 License: Apache-2.0 Imports: 48 Imported by: 0

Documentation ¶

Index ¶

Constants ¶

View Source
const (
	VIEW_INDEX = "index"
)

Variables ¶

View Source
var (
	NotFound = func() Response {
		return ApiError(404, "Not found", nil)
	}
	ServerError = func(err error) Response {
		return ApiError(500, "Server error", err)
	}
)

Functions ¶

func AddDataSource ¶

func AddDataSource(c *middleware.Context, cmd m.AddDataSourceCommand)

func AdminCreateUser ¶

func AdminCreateUser(c *middleware.Context, form dtos.AdminCreateUserForm)

func AdminDeleteUser ¶

func AdminDeleteUser(c *middleware.Context)

func AdminGetSettings ¶

func AdminGetSettings(c *middleware.Context)

func AdminGetStats ¶

func AdminGetStats(c *middleware.Context)

func AdminUpdateUserPassword ¶

func AdminUpdateUserPassword(c *middleware.Context, form dtos.AdminUpdateUserPasswordForm)

func AdminUpdateUserPermissions ¶

func AdminUpdateUserPermissions(c *middleware.Context, form dtos.AdminUpdateUserPermissionsForm)

func AppPluginRoute ¶

func AppPluginRoute(route *plugins.AppPluginRoute, appId string) macaron.Handler

func ChangeActiveOrgAndRedirectToHome ¶

func ChangeActiveOrgAndRedirectToHome(c *middleware.Context)

GET /profile/switch-org/:id

func CreateDashboardSnapshot ¶

func CreateDashboardSnapshot(c *middleware.Context, cmd m.CreateDashboardSnapshotCommand)

func DataProxyTransport ¶

func DataProxyTransport(ds *m.DataSource) (*http.Transport, error)

func DeleteDashboard ¶

func DeleteDashboard(c *middleware.Context)

func DeleteDashboardSnapshot ¶

func DeleteDashboardSnapshot(c *middleware.Context)

func DeleteDataSource ¶

func DeleteDataSource(c *middleware.Context)

func GenStateString ¶

func GenStateString() string

func GetDashboard ¶

func GetDashboard(c *middleware.Context)

func GetDashboardFromJsonFile ¶

func GetDashboardFromJsonFile(c *middleware.Context)

func GetDashboardSnapshot ¶

func GetDashboardSnapshot(c *middleware.Context)

func GetDashboardTags ¶

func GetDashboardTags(c *middleware.Context)

func GetDataSources ¶

func GetDataSources(c *middleware.Context)

func GetFrontendSettings ¶

func GetFrontendSettings(c *middleware.Context)

func GetSharingOptions ¶

func GetSharingOptions(c *middleware.Context)

func Index ¶

func Index(c *middleware.Context)

func InitAppPluginRoutes ¶

func InitAppPluginRoutes(r *macaron.Macaron)

func LoadPlaylistDashboards ¶

func LoadPlaylistDashboards(orgId, userId, playlistId int64) (dtos.PlaylistDashboardsSlice, error)

func LoadPlaylistItemDTOs ¶

func LoadPlaylistItemDTOs(id int64) ([]m.PlaylistItemDTO, error)

func LoadPlaylistItems ¶

func LoadPlaylistItems(id int64) ([]m.PlaylistItem, error)

func LoginApiPing ¶

func LoginApiPing(c *middleware.Context)

func LoginView ¶

func LoginView(c *middleware.Context)

func Logout ¶

func Logout(c *middleware.Context)

func NewReverseProxy ¶

func NewReverseProxy(ds *m.DataSource, proxyPath string, targetUrl *url.URL) *httputil.ReverseProxy

func NotFoundHandler ¶

func NotFoundHandler(c *middleware.Context)

func OAuthLogin ¶

func OAuthLogin(ctx *middleware.Context)

func ProxyDataSourceRequest ¶

func ProxyDataSourceRequest(c *middleware.Context)

func ProxyGnetRequest ¶

func ProxyGnetRequest(c *middleware.Context)

func Register ¶

func Register(r *macaron.Macaron)

Register adds http routes

func RenderToPng ¶

func RenderToPng(c *middleware.Context)

func ReverseProxyGnetReq ¶

func ReverseProxyGnetReq(proxyPath string) *httputil.ReverseProxy
func Search(c *middleware.Context)

func ValidateOrgAlert ¶

func ValidateOrgAlert(c *middleware.Context)

func ValidateOrgPlaylist ¶

func ValidateOrgPlaylist(c *middleware.Context)

Types ¶

type NormalResponse ¶

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

func ApiError ¶

func ApiError(status int, message string, err error) *NormalResponse

func ApiSuccess ¶

func ApiSuccess(message string) *NormalResponse

func Empty ¶

func Empty(status int) *NormalResponse

functions to create responses

func Json ¶

func Json(status int, body interface{}) *NormalResponse

func Respond ¶

func Respond(status int, body interface{}) *NormalResponse

func (*NormalResponse) Cache ¶

func (r *NormalResponse) Cache(ttl string) *NormalResponse

func (*NormalResponse) Header ¶

func (r *NormalResponse) Header(key, value string) *NormalResponse

func (*NormalResponse) WriteTo ¶

func (r *NormalResponse) WriteTo(ctx *middleware.Context)

type Response ¶

type Response interface {
	WriteTo(ctx *middleware.Context)
}

func AddApiKey ¶

func AddApiKey(c *middleware.Context, cmd m.AddApiKeyCommand) Response

func AddOrgInvite ¶

func AddOrgInvite(c *middleware.Context, inviteDto dtos.AddInviteForm) Response

func AddOrgUser ¶

func AddOrgUser(c *middleware.Context, cmd m.AddOrgUserCommand) Response

POST /api/orgs/:orgId/users

func AddOrgUserToCurrentOrg ¶

func AddOrgUserToCurrentOrg(c *middleware.Context, cmd m.AddOrgUserCommand) Response

POST /api/org/users

func AlertTest ¶

func AlertTest(c *middleware.Context, dto dtos.AlertTestCommand) Response

POST /api/alerts/test

func CompleteInvite ¶

func CompleteInvite(c *middleware.Context, completeInvite dtos.CompleteInviteForm) Response

func CreateOrg ¶

func CreateOrg(c *middleware.Context, cmd m.CreateOrgCommand) Response

POST /api/orgs

func DelAlert ¶

func DelAlert(c *middleware.Context) Response

DEL /api/alerts/:id

func DeleteAlertNotification ¶

func DeleteAlertNotification(c *middleware.Context) Response

func DeleteApiKey ¶

func DeleteApiKey(c *middleware.Context) Response

func DeleteOrgById ¶

func DeleteOrgById(c *middleware.Context) Response

GET /api/orgs/:orgId

func DeletePlaylist ¶

func DeletePlaylist(c *middleware.Context) Response

func GenerateError ¶

func GenerateError(c *middleware.Context) Response

Genereates a index out of range error

func GetAlert ¶

func GetAlert(c *middleware.Context) Response

GET /api/alerts/:id

func GetAlertNotificationById ¶

func GetAlertNotificationById(c *middleware.Context) Response

func GetAlertNotifications ¶

func GetAlertNotifications(c *middleware.Context) Response

func GetAlertStatesForDashboard ¶

func GetAlertStatesForDashboard(c *middleware.Context) Response

func GetAlerts ¶

func GetAlerts(c *middleware.Context) Response

GET /api/alerts

func GetAnnotations ¶

func GetAnnotations(c *middleware.Context) Response

func GetApiKeys ¶

func GetApiKeys(c *middleware.Context) Response

func GetDataSourceById ¶

func GetDataSourceById(c *middleware.Context) Response

func GetDataSourceByName ¶

func GetDataSourceByName(c *middleware.Context) Response

Get /api/datasources/name/:name

func GetDataSourceIdByName ¶

func GetDataSourceIdByName(c *middleware.Context) Response

Get /api/datasources/id/:name

func GetHomeDashboard ¶

func GetHomeDashboard(c *middleware.Context) Response

func GetInternalMetrics ¶

func GetInternalMetrics(c *middleware.Context) Response

func GetInviteInfoByCode ¶

func GetInviteInfoByCode(c *middleware.Context) Response

func GetOrgById ¶

func GetOrgById(c *middleware.Context) Response

GET /api/orgs/:orgId

func GetOrgByName ¶

func GetOrgByName(c *middleware.Context) Response

Get /api/orgs/name/:name

func GetOrgCurrent ¶

func GetOrgCurrent(c *middleware.Context) Response

GET /api/org

func GetOrgPreferences ¶

func GetOrgPreferences(c *middleware.Context) Response

GET /api/org/preferences

func GetOrgQuotas ¶

func GetOrgQuotas(c *middleware.Context) Response

func GetOrgUsers ¶

func GetOrgUsers(c *middleware.Context) Response

GET /api/orgs/:orgId/users

func GetOrgUsersForCurrentOrg ¶

func GetOrgUsersForCurrentOrg(c *middleware.Context) Response

GET /api/org/users

func GetPendingOrgInvites ¶

func GetPendingOrgInvites(c *middleware.Context) Response

func GetPlaylist ¶

func GetPlaylist(c *middleware.Context) Response

func GetPlaylistDashboards ¶

func GetPlaylistDashboards(c *middleware.Context) Response

func GetPlaylistItems ¶

func GetPlaylistItems(c *middleware.Context) Response

func GetPluginDashboards ¶

func GetPluginDashboards(c *middleware.Context) Response

func GetPluginList ¶

func GetPluginList(c *middleware.Context) Response

func GetPluginReadme ¶

func GetPluginReadme(c *middleware.Context) Response

func GetPluginSettingById ¶

func GetPluginSettingById(c *middleware.Context) Response

func GetSignUpOptions ¶

func GetSignUpOptions(c *middleware.Context) Response

GET /api/user/signup/options

func GetSignedInUser ¶

func GetSignedInUser(c *middleware.Context) Response

GET /api/user (current authenticated user)

func GetSignedInUserOrgList ¶

func GetSignedInUserOrgList(c *middleware.Context) Response

GET /api/user/orgs

func GetTestDataScenarios ¶

func GetTestDataScenarios(c *middleware.Context) Response

GET /api/tsdb/testdata/scenarios

func GetUserById ¶

func GetUserById(c *middleware.Context) Response

GET /api/user/:id

func GetUserOrgList ¶

func GetUserOrgList(c *middleware.Context) Response

GET /api/user/:id/orgs

func GetUserPreferences ¶

func GetUserPreferences(c *middleware.Context) Response

GET /api/user/preferences

func GetUserQuotas ¶

func GetUserQuotas(c *middleware.Context) Response

func LoginPost ¶

func LoginPost(c *middleware.Context, cmd dtos.LoginCommand) Response

func NotificationTest ¶

func NotificationTest(c *middleware.Context, dto dtos.NotificationTestCommand) Response

POST /api/alert-notifications/test

func PauseAlert ¶

func PauseAlert(c *middleware.Context, dto dtos.PauseAlertCommand) Response

POST /api/alerts/:alertId/pause

func QueryMetrics ¶

func QueryMetrics(c *middleware.Context, reqDto dtos.MetricRequest) Response

POST /api/tsdb/query

func RemoveOrgUser ¶

func RemoveOrgUser(c *middleware.Context) Response

DELETE /api/orgs/:orgId/users/:userId

func RemoveOrgUserForCurrentOrg ¶

func RemoveOrgUserForCurrentOrg(c *middleware.Context) Response

DELETE /api/org/users/:userId

func RevokeInvite ¶

func RevokeInvite(c *middleware.Context) Response

func SearchDashboardSnapshots ¶

func SearchDashboardSnapshots(c *middleware.Context) Response

func SearchOrgs ¶

func SearchOrgs(c *middleware.Context) Response

func SearchPlaylists ¶

func SearchPlaylists(c *middleware.Context) Response

func SearchUsers ¶

func SearchUsers(c *middleware.Context) Response

GET /api/users

func SetHomeDashboard ¶

func SetHomeDashboard(c *middleware.Context, cmd m.SavePreferencesCommand) Response

POST /api/preferences/set-home-dash

func SignUp ¶

func SignUp(c *middleware.Context, form dtos.SignUpForm) Response

POST /api/user/signup

func SignUpStep2 ¶

func SignUpStep2(c *middleware.Context, form dtos.SignUpStep2Form) Response

func StarDashboard ¶

func StarDashboard(c *middleware.Context) Response

func UnstarDashboard ¶

func UnstarDashboard(c *middleware.Context) Response

func UpdateOrg ¶

func UpdateOrg(c *middleware.Context, form dtos.UpdateOrgForm) Response

PUT /api/orgs/:orgId

func UpdateOrgAddress ¶

func UpdateOrgAddress(c *middleware.Context, form dtos.UpdateOrgAddressForm) Response

PUT /api/orgs/:orgId/address

func UpdateOrgAddressCurrent ¶

func UpdateOrgAddressCurrent(c *middleware.Context, form dtos.UpdateOrgAddressForm) Response

PUT /api/org/address

func UpdateOrgCurrent ¶

func UpdateOrgCurrent(c *middleware.Context, form dtos.UpdateOrgForm) Response

PUT /api/org

func UpdateOrgPreferences ¶

func UpdateOrgPreferences(c *middleware.Context, dtoCmd dtos.UpdatePrefsCmd) Response

PUT /api/org/preferences

func UpdateOrgQuota ¶

func UpdateOrgQuota(c *middleware.Context, cmd m.UpdateOrgQuotaCmd) Response

func UpdateOrgUser ¶

func UpdateOrgUser(c *middleware.Context, cmd m.UpdateOrgUserCommand) Response

PATCH /api/orgs/:orgId/users/:userId

func UpdateOrgUserForCurrentOrg ¶

func UpdateOrgUserForCurrentOrg(c *middleware.Context, cmd m.UpdateOrgUserCommand) Response

PATCH /api/org/users/:userId

func UpdateSignedInUser ¶

func UpdateSignedInUser(c *middleware.Context, cmd m.UpdateUserCommand) Response

POST /api/user

func UpdateUser ¶

func UpdateUser(c *middleware.Context, cmd m.UpdateUserCommand) Response

POST /api/users/:id

func UpdateUserActiveOrg ¶

func UpdateUserActiveOrg(c *middleware.Context) Response

POST /api/users/:id/using/:orgId

func UpdateUserPreferences ¶

func UpdateUserPreferences(c *middleware.Context, dtoCmd dtos.UpdatePrefsCmd) Response

PUT /api/user/preferences

func UpdateUserQuota ¶

func UpdateUserQuota(c *middleware.Context, cmd m.UpdateUserQuotaCmd) Response

func UserSetUsingOrg ¶

func UserSetUsingOrg(c *middleware.Context) Response

POST /api/user/using/:id

Directories ¶

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL