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 *chi.Mux, s Server) *chi.Mux
- 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) GetDashboardSummary(ctx context.Context, req *apipb.GetDashboardSummaryRequest) (*apipb.GetDashboardSummaryResponse, error)
- func (s Server) GetDashboardSummaryHTTP(w http.ResponseWriter, r *http.Request)
- func (s *Server) GetTabSummary(ctx context.Context, req *apipb.GetTabSummaryRequest) (*apipb.GetTabSummaryResponse, error)
- func (s Server) GetTabSummaryHTTP(w http.ResponseWriter, r *http.Request)
- func (s Server) Grid(ctx context.Context, scope string, ...) (*statepb.Grid, error)
- func (s Server) ListDashboardGroupHTTP(w http.ResponseWriter, r *http.Request)
- func (s *Server) ListDashboardGroups(ctx context.Context, req *apipb.ListDashboardGroupsRequest) (*apipb.ListDashboardGroupsResponse, error)
- func (s *Server) ListDashboardSummaries(ctx context.Context, req *apipb.ListDashboardSummariesRequest) (*apipb.ListDashboardSummariesResponse, error)
- func (s Server) ListDashboardSummariesHTTP(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) ListDashboards(ctx context.Context, req *apipb.ListDashboardsRequest) (*apipb.ListDashboardsResponse, error)
- 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)
- func (s *Server) ListTabSummaries(ctx context.Context, req *apipb.ListTabSummariesRequest) (*apipb.ListTabSummariesResponse, error)
- func (s Server) ListTabSummariesHTTP(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.ConditionalClient DefaultBucket string TabPathPrefix string SummaryPathPrefix string AccessControlAllowOrigin string Timeout time.Duration // contains filtered or unexported fields }
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(ctx context.Context, req *apipb.GetDashboardRequest) (*apipb.GetDashboardResponse, error)
GetDashboard returns a given dashboard
func (*Server) GetDashboardGroup ¶ added in v0.0.80
func (s *Server) GetDashboardGroup(ctx context.Context, req *apipb.GetDashboardGroupRequest) (*apipb.GetDashboardGroupResponse, error)
GetDashboardGroup returns a given dashboard group
func (Server) GetDashboardGroupHTTP ¶ added in v0.0.118
func (s Server) GetDashboardGroupHTTP(w http.ResponseWriter, r *http.Request)
GetDashboardGroupHTTP returns a given dashboard group Response json: GetDashboardGroupResponse
func (Server) GetDashboardHTTP ¶ added in v0.0.118
func (s Server) GetDashboardHTTP(w http.ResponseWriter, r *http.Request)
GetDashboardHTTP returns a given dashboard Response json: GetDashboardResponse
func (*Server) GetDashboardSummary ¶ added in v0.0.159
func (s *Server) GetDashboardSummary(ctx context.Context, req *apipb.GetDashboardSummaryRequest) (*apipb.GetDashboardSummaryResponse, error)
GetDashboardSummary returns the dashboard summary for the particular dashboard. Think of it as aggregated view of ListTabSummaries data. Dashboard name doesn't have to be normalized. Returns an error iff - dashboard name does not exist in config - the server can't read summary from GCS bucket - dashboard summary doesn't exist
func (Server) GetDashboardSummaryHTTP ¶ added in v0.0.160
func (s Server) GetDashboardSummaryHTTP(w http.ResponseWriter, r *http.Request)
GetDashboardSummaryHTTP returns the dashboard summary as a json. Response json: GetDashboardSummaryResponse
func (*Server) GetTabSummary ¶ added in v0.0.155
func (s *Server) GetTabSummary(ctx context.Context, req *apipb.GetTabSummaryRequest) (*apipb.GetTabSummaryResponse, error)
GetTabSummary returns the tab summary for the particular dashboard and tab. Dashboard and tab names don't have to be normalized. Returns an error iff - dashboard or tab does not exist - the server can't read summary from GCS bucket - tab summary for particular tab doesn't exist
func (Server) GetTabSummaryHTTP ¶ added in v0.0.155
func (s Server) GetTabSummaryHTTP(w http.ResponseWriter, r *http.Request)
GetTabSummaryHTTP returns the tab summary as a json. Response json: GetTabSummaryResponse
func (Server) Grid ¶ added in v0.0.92
func (s Server) Grid(ctx context.Context, scope string, dashboardName, tabName, testGroupNanme string) (*statepb.Grid, error)
Grid fetch tab and grid info (columns, rows, ..etc)
func (Server) ListDashboardGroupHTTP ¶ added in v0.0.118
func (s Server) ListDashboardGroupHTTP(w http.ResponseWriter, r *http.Request)
ListDashboardGroupHTTP returns every dashboard group in TestGrid Response json: ListDashboardGroupResponse
func (*Server) ListDashboardGroups ¶
func (s *Server) ListDashboardGroups(ctx context.Context, req *apipb.ListDashboardGroupsRequest) (*apipb.ListDashboardGroupsResponse, error)
ListDashboardGroup returns every dashboard group in TestGrid
func (*Server) ListDashboardSummaries ¶ added in v0.0.159
func (s *Server) ListDashboardSummaries(ctx context.Context, req *apipb.ListDashboardSummariesRequest) (*apipb.ListDashboardSummariesResponse, error)
ListDashboardSummaries returns the list of dashboard summaries for the particular dashboard group. Think of it as aggregated view of ListTabSummaries data. Dashboard group name doesn't have to be normalized. Returns an error iff - dashboard name does not exist in config - the server can't read summary from GCS bucket
func (Server) ListDashboardSummariesHTTP ¶ added in v0.0.160
func (s Server) ListDashboardSummariesHTTP(w http.ResponseWriter, r *http.Request)
ListDashboardSummariesHTTP returns the list of dashboard summaries as a json. Response json: ListDashboardSummariesResponse
func (*Server) ListDashboardTabs ¶ added in v0.0.91
func (s *Server) ListDashboardTabs(ctx context.Context, req *apipb.ListDashboardTabsRequest) (*apipb.ListDashboardTabsResponse, error)
ListDashboardTabs returns a given dashboard tabs
func (Server) ListDashboardTabsHTTP ¶ added in v0.0.118
func (s Server) ListDashboardTabsHTTP(w http.ResponseWriter, r *http.Request)
ListDashboardTabsHTTP returns a given dashboard tabs Response json: ListDashboardTabsResponse
func (*Server) ListDashboards ¶ added in v0.0.91
func (s *Server) ListDashboards(ctx context.Context, req *apipb.ListDashboardsRequest) (*apipb.ListDashboardsResponse, error)
ListDashboard returns every dashboard in TestGrid
func (Server) ListDashboardsHTTP ¶ added in v0.0.118
func (s Server) ListDashboardsHTTP(w http.ResponseWriter, r *http.Request)
ListDashboardsHTTP returns every dashboard in TestGrid Response json: ListDashboardResponse
func (*Server) ListHeaders ¶ added in v0.0.92
func (s *Server) ListHeaders(ctx context.Context, req *apipb.ListHeadersRequest) (*apipb.ListHeadersResponse, error)
ListHeaders returns dashboard tab headers
func (Server) ListHeadersHTTP ¶ added in v0.0.118
func (s Server) ListHeadersHTTP(w http.ResponseWriter, r *http.Request)
ListHeadersHTTP returns dashboard tab headers Response json: ListHeadersResponse
func (*Server) ListRows ¶ added in v0.0.92
func (s *Server) ListRows(ctx context.Context, req *apipb.ListRowsRequest) (*apipb.ListRowsResponse, error)
ListRows returns dashboard tab rows
func (Server) ListRowsHTTP ¶ added in v0.0.118
func (s Server) ListRowsHTTP(w http.ResponseWriter, r *http.Request)
ListRowsHTTP returns dashboard tab rows Response json: ListRowsResponse
func (*Server) ListTabSummaries ¶ added in v0.0.155
func (s *Server) ListTabSummaries(ctx context.Context, req *apipb.ListTabSummariesRequest) (*apipb.ListTabSummariesResponse, error)
ListTabSummaries returns the list of tab summaries for the particular dashboard. Dashboard name doesn't have to be normalized. Returns an error iff dashboard does not exist OR the server can't read summary from GCS bucket.
func (Server) ListTabSummariesHTTP ¶ added in v0.0.155
func (s Server) ListTabSummariesHTTP(w http.ResponseWriter, r *http.Request)
ListTabSummariesHTTP returns the list of tab summaries as a json. Response json: ListTabSummariesResponse