Documentation
¶
Overview ¶
Package v1 (api/v1) is the first versioned implementation of the API
Package v1 (api/v1) is the first versioned implementation of the API
Index ¶
- func Route(r *mux.Router, s Server) *mux.Router
- type Server
- func (s Server) GetDashboard(w http.ResponseWriter, r *http.Request)
- func (s Server) GetDashboardGroup(w http.ResponseWriter, r *http.Request)
- func (s Server) Grid(r *http.Request, cfg *configpb.Configuration, dashboardKey string, ...) (*statepb.Grid, error)
- func (s Server) GroupGrid(configPath *gcs.Path, groupName string) (*statepb.Grid, error)
- func (s Server) ListDashboardGroups(w http.ResponseWriter, r *http.Request)
- func (s Server) ListDashboardTabs(w http.ResponseWriter, r *http.Request)
- func (s Server) ListDashboards(w http.ResponseWriter, r *http.Request)
- func (s Server) ListHeaders(w http.ResponseWriter, r *http.Request)
- func (s Server) ListRows(w http.ResponseWriter, r *http.Request)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Server ¶
type Server struct {
Client gcs.Client
Host string
DefaultBucket string
GridPathPrefix string
Timeout time.Duration
}
Server contains the necessary settings and i/o objects needed to serve this api
func (Server) GetDashboard ¶ added in v0.0.91
func (s Server) GetDashboard(w http.ResponseWriter, r *http.Request)
GetDashboard returns a given dashboard Response json: GetDashboardResponse
func (Server) GetDashboardGroup ¶ added in v0.0.80
func (s Server) GetDashboardGroup(w http.ResponseWriter, r *http.Request)
GetDashboardGroup returns a given dashboard group Response json: GetDashboardGroupResponse
func (Server) Grid ¶ added in v0.0.92
func (s Server) Grid(r *http.Request, cfg *configpb.Configuration, dashboardKey string, tabKey string) (*statepb.Grid, error)
Grid fetch tab and grid info (columns, rows, ..etc)
func (Server) GroupGrid ¶ added in v0.0.92
GroupGrid fetch tab group name grid info (columns, rows, ..etc)
func (Server) ListDashboardGroups ¶
func (s Server) ListDashboardGroups(w http.ResponseWriter, r *http.Request)
ListDashboardGroups returns every dashboard group in TestGrid Response json: ListDashboardGroupResponse
func (Server) ListDashboardTabs ¶ added in v0.0.91
func (s Server) ListDashboardTabs(w http.ResponseWriter, r *http.Request)
ListDashboardTabs returns a given dashboard tabs Response json: ListDashboardTabsResponse
func (Server) ListDashboards ¶ added in v0.0.91
func (s Server) ListDashboards(w http.ResponseWriter, r *http.Request)
ListDashboards returns every dashboard in TestGrid Response json: ListDashboardResponse
func (Server) ListHeaders ¶ added in v0.0.92
func (s Server) ListHeaders(w http.ResponseWriter, r *http.Request)
ListHeaders returns dashboard tab headers Response json: ListHeadersResponse
Source Files