v1

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(ctx context.Context, req *apipb.GetDashboardRequest) (*apipb.GetDashboardResponse, error)
  • func (s *Server) GetDashboardGroup(ctx context.Context, req *apipb.GetDashboardGroupRequest) (*apipb.GetDashboardGroupResponse, error)
  • func (s Server) GetDashboardGroupHTTP(w http.ResponseWriter, r *http.Request)
  • func (s Server) GetDashboardHTTP(w http.ResponseWriter, r *http.Request)
  • func (s Server) Grid(ctx context.Context, scope string, cfg *configpb.Configuration, ...) (*statepb.Grid, error)
  • func (s Server) GroupGrid(ctx context.Context, configPath *gcs.Path, groupName string) (*statepb.Grid, error)
  • func (s *Server) ListDashboard(ctx context.Context, req *apipb.ListDashboardRequest) (*apipb.ListDashboardResponse, error)
  • func (s *Server) ListDashboardGroup(ctx context.Context, req *apipb.ListDashboardGroupRequest) (*apipb.ListDashboardGroupResponse, error)
  • func (s Server) ListDashboardGroupHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) ListDashboardTabs(ctx context.Context, req *apipb.ListDashboardTabsRequest) (*apipb.ListDashboardTabsResponse, error)
  • func (s Server) ListDashboardTabsHTTP(w http.ResponseWriter, r *http.Request)
  • func (s Server) ListDashboardsHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) ListHeaders(ctx context.Context, req *apipb.ListHeadersRequest) (*apipb.ListHeadersResponse, error)
  • func (s Server) ListHeadersHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) ListRows(ctx context.Context, req *apipb.ListRowsRequest) (*apipb.ListRowsResponse, error)
  • func (s Server) ListRowsHTTP(w http.ResponseWriter, r *http.Request)

Functions

func Route

func Route(r *mux.Router, s Server) *mux.Router

Route applies all the v1 API functions provided by the Server to the Router given. If the router is nil, a new one is instantiated.

Types

type Server

type Server struct {
	Client         gcs.Client
	Host           *url.URL
	DefaultBucket  string
	GridPathPrefix string
	TabPathPrefix  string
	Timeout        time.Duration
}

Server contains the necessary settings and i/o objects needed to serve this api

func (*Server) GetDashboard

func (s *Server) GetDashboard(ctx context.Context, req *apipb.GetDashboardRequest) (*apipb.GetDashboardResponse, error)

GetDashboardHTTP returns a given dashboard

func (*Server) GetDashboardGroup

func (s *Server) GetDashboardGroup(ctx context.Context, req *apipb.GetDashboardGroupRequest) (*apipb.GetDashboardGroupResponse, error)

GetDashboardGroup returns a given dashboard group

func (Server) GetDashboardGroupHTTP

func (s Server) GetDashboardGroupHTTP(w http.ResponseWriter, r *http.Request)

GetDashboardGroupHTTP returns a given dashboard group Response json: GetDashboardGroupResponse

func (Server) GetDashboardHTTP

func (s Server) GetDashboardHTTP(w http.ResponseWriter, r *http.Request)

GetDashboardHTTP returns a given dashboard Response json: GetDashboardResponse

func (Server) Grid

func (s Server) Grid(ctx context.Context, scope string, cfg *configpb.Configuration, dashboardKey string, tabKey string) (*statepb.Grid, error)

Grid fetch tab and grid info (columns, rows, ..etc)

func (Server) GroupGrid

func (s Server) GroupGrid(ctx context.Context, configPath *gcs.Path, groupName string) (*statepb.Grid, error)

GroupGrid fetch tab group name grid info (columns, rows, ..etc)

func (*Server) ListDashboard

func (s *Server) ListDashboard(ctx context.Context, req *apipb.ListDashboardRequest) (*apipb.ListDashboardResponse, error)

ListDashboard returns every dashboard in TestGrid

func (*Server) ListDashboardGroup

func (s *Server) ListDashboardGroup(ctx context.Context, req *apipb.ListDashboardGroupRequest) (*apipb.ListDashboardGroupResponse, error)

ListDashboardGroup returns every dashboard group in TestGrid

func (Server) ListDashboardGroupHTTP

func (s Server) ListDashboardGroupHTTP(w http.ResponseWriter, r *http.Request)

ListDashboardGroupHTTP returns every dashboard group in TestGrid Response json: ListDashboardGroupResponse

func (*Server) ListDashboardTabs

func (s *Server) ListDashboardTabs(ctx context.Context, req *apipb.ListDashboardTabsRequest) (*apipb.ListDashboardTabsResponse, error)

ListDashboardTabsHTTP returns a given dashboard tabs

func (Server) ListDashboardTabsHTTP

func (s Server) ListDashboardTabsHTTP(w http.ResponseWriter, r *http.Request)

ListDashboardTabsHTTP returns a given dashboard tabs Response json: ListDashboardTabsResponse

func (Server) ListDashboardsHTTP

func (s Server) ListDashboardsHTTP(w http.ResponseWriter, r *http.Request)

ListDashboardsHTTP returns every dashboard in TestGrid Response json: ListDashboardResponse

func (*Server) ListHeaders

func (s *Server) ListHeaders(ctx context.Context, req *apipb.ListHeadersRequest) (*apipb.ListHeadersResponse, error)

ListHeaders returns dashboard tab headers

func (Server) ListHeadersHTTP

func (s Server) ListHeadersHTTP(w http.ResponseWriter, r *http.Request)

ListHeadersHTTP returns dashboard tab headers Response json: ListHeadersResponse

func (*Server) ListRows

func (s *Server) ListRows(ctx context.Context, req *apipb.ListRowsRequest) (*apipb.ListRowsResponse, error)

ListRows returns dashboard tab rows

func (Server) ListRowsHTTP

func (s Server) ListRowsHTTP(w http.ResponseWriter, r *http.Request)

ListRowsHTTP returns dashboard tab rows Response json: ListRowsResponse