package testgrid.api.v1

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ListDashboards (ListDashboardsRequest, ListDashboardsResponse)

  data.proto:15

  GET /dashboards Lists dashboard names

  message ListDashboardsRequest

  data.proto:59

  • string scope = 1

  message ListDashboardsResponse

  data.proto:61

  • repeated DashboardResource dashboards = 1

• rpc ListDashboardGroups (ListDashboardGroupsRequest, ListDashboardGroupsResponse)

  data.proto:19

  GET /dashboard-groups Lists the dashboard group names

  message ListDashboardGroupsRequest

  data.proto:63

  • string scope = 1

  message ListDashboardGroupsResponse

  data.proto:65

  • repeated Resource dashboard_groups = 1

• rpc ListDashboardTabs (ListDashboardTabsRequest, ListDashboardTabsResponse)

  data.proto:24

  GET /dashboards/{dashboard}/tabs Lists the dashboard tab names

  message ListDashboardTabsRequest

  data.proto:67

  • string scope = 1

  • string dashboard = 2

  message ListDashboardTabsResponse

  data.proto:72

  • repeated Resource dashboard_tabs = 1

• rpc GetDashboard (GetDashboardRequest, GetDashboardResponse)

  data.proto:30

  GET /dashboards/{dashboard} Returns a Dashboard config's metadata Excludes subtabs, accessed through the /tabs list method instead

  message GetDashboardRequest

  data.proto:74

  • string scope = 1

  • string dashboard = 2

  message GetDashboardResponse

  data.proto:79

  • repeated config.Notification notifications = 1

    A list of notifications attached to this dashboard. This is displayed on any dashboard tab in this dashboard.

  • string default_tab = 2

    Control which tab is displayed when first opening a dashboard. Defaults to Summary

  • bool suppress_failing_tabs = 3

    Controls whether to suppress highlighting of failing tabs.

  • bool highlight_today = 4

    Controls whether to apply special highlighting to result header columns for the current day.

• rpc GetDashboardGroup (GetDashboardGroupRequest, GetDashboardGroupResponse)

  data.proto:34

  GET /dashboard-groups/{dashboard-group} Lists the dashboard names in that group

  message GetDashboardGroupRequest

  data.proto:96

  • string scope = 1

  • string dashboard_group = 2

  message GetDashboardGroupResponse

  data.proto:101

  • repeated Resource dashboards = 1

• rpc ListHeaders (ListHeadersRequest, ListHeadersResponse)

  data.proto:39

  GET /dashboards/{dashboard}/tabs/{tab}/headers Returns the headers for grid results

  message ListHeadersRequest

  data.proto:103

  • string scope = 1

  • string dashboard = 2

  • string tab = 3

  message ListHeadersResponse

  data.proto:109

  • repeated ListHeadersResponse.Header headers = 1

• rpc ListRows (ListRowsRequest, ListRowsResponse)

  data.proto:43

  GET /dashboards/{dashboard}/tabs/{tab}/rows Returns information on grid rows, and data within those rows

  message ListRowsRequest

  data.proto:132

  • string scope = 1

  • string dashboard = 2

  • string tab = 3

  message ListRowsResponse

  data.proto:138

  • repeated ListRowsResponse.Row rows = 1

• rpc ListTabSummaries (ListTabSummariesRequest, ListTabSummariesResponse)

  data.proto:47

  GET /dashboards/{dashboard}/tab-summaries Returns the list of tab summaries for dashboard.

  message ListTabSummariesRequest

  data.proto:182

  • string scope = 1

    Scope defines the GCS bucket to read the results from.

  • string dashboard = 2

    Name of the dashboard to fetch tab summaries for.

  message ListTabSummariesResponse

  data.proto:190

  • repeated TabSummary tab_summaries = 1

    List of tab summaries.

• rpc GetTabSummary (GetTabSummaryRequest, GetTabSummaryResponse)

  data.proto:50

  GET /dashboards/{dashboard}/tab-summaries/{tab}

  message GetTabSummaryRequest

  data.proto:195

  • string scope = 1

    Scope defines the GCS bucket to read the results from.

  • string dashboard = 2

    Name of the dashboard to fetch tab summaries for.

  • string tab = 3

    Name of the particular tab to fetch the summary for.

  message GetTabSummaryResponse

  data.proto:206

  • optional TabSummary tab_summary = 1

    Summary for the tab

• rpc ListDashboardSummaries (ListDashboardSummariesRequest, ListDashboardSummariesResponse)

  data.proto:53

  GET /dashboard-groups/{dashboard-group}/dashboard-summaries

  message ListDashboardSummariesRequest

  data.proto:211

  • string scope = 1

    Scope defines the GCS bucket to read the results from.

  • string dashboard_group = 2

    Name of the dashboard group to fetch dashboard summaries for.

  message ListDashboardSummariesResponse

  data.proto:219

  • repeated DashboardSummary dashboard_summaries = 1

    List of dashboard summaries.

• rpc GetDashboardSummary (GetDashboardSummaryRequest, GetDashboardSummaryResponse)

  data.proto:56

  GET /dashboards/{dashboard}/summary

  message GetDashboardSummaryRequest

  data.proto:224

  • string scope = 1

    Scope defines the GCS bucket to read the results from.

  • string dashboard = 2

    Name of the dashboard to fetch the summary for.

  message GetDashboardSummaryResponse

  data.proto:232

  • optional DashboardSummary dashboard_summary = 1

    Summary for the dashboard.

A DashboardResource is a REST resource for a dashboard It includes the name of the resource, a link, and a dashboard group to which it belongs

Used in: ListDashboardsResponse

• string name = 1

• string link = 2

• string dashboard_group_name = 3

  Dashboard group to which the dashboard belongs to. Empty if dashboard doesn't belong to any group.

Summary for a particular dashboard. Contains the info required to render dashboard summary in UI (done in the dashboard group view).

Used in: GetDashboardSummaryResponse, ListDashboardSummariesResponse

• string name = 1

  Name of the dashboard.

• string overall_status = 2

  Overall status of the dashboard. Will be calculated based on the presence and importance of underlying tabs.

• map<string, int32> tab_status_count = 3

  Count of the tabs by status.

Subset of data from FailingTestSummary defined in summary.proto.

Used in: FailuresSummary

• string display_name = 1

  Name of the failing test.

• int32 fail_count = 2

  number of times the test has failed.

• optional google.protobuf.Timestamp pass_timestamp = 3

  Timestamp for the last cycle in which the test passed.

• optional google.protobuf.Timestamp fail_timestamp = 4

  Timestamp for the first cycle in which the test failed.

Aggregate stats across all failing tests.

Used in: FailuresSummary

• int32 num_failing_tests = 1

  Number of failing tests for the tab.

Summarized representation of data from failing test summaries. Will be rendered in failures summary component within tab summary.

Used in: TabSummary

• repeated FailingTestInfo top_failing_tests = 1

  Top failing tests by fail count.

• optional FailureStats failure_stats = 2

  Aggregated stats across all failing tests.

Subset of data from HealthinessInfo.TestInfo defined in summary.proto.

Used in: HealthinessSummary

• string display_name = 1

  Name of the flaky test.

• float flakiness = 2

  The flakiness of the test, in % measured out of 100

• summary.TestInfo.Trend change = 3

  The change of flakiness based on the last interval's flakiness The interval is set by each tab's config, with a default of 7 days.

Aggregated healthiness stats across the tab.

Used in: HealthinessSummary

• optional google.protobuf.Timestamp start = 1

  The start of the time frame that the analysis was run for.

• optional google.protobuf.Timestamp end = 2

  The end of the time frame that the analysis was run for.

• int32 num_flaky_tests = 3

  Number of flaky tests in the tab.

• float average_flakiness = 4

  Average flakiness for the current analysis interval.

• float previous_flakiness = 5

  Average flakiness for the previous analysis interval.

Summarized representation of data from tab's HealthinessInfo. Will be rendered in healthiness summary component within tab summary.

Used in: TabSummary

• repeated FlakyTestInfo top_flaky_tests = 1

  Top flaky tests (with flakiness > 0) by the current flakiness %.

• optional HealthinessStats healthiness_stats = 2

  Aggregated healthiness stats for the tab.

Used in: ListHeadersResponse

• string build = 1

  Unique instance of the job, typically BUILD_NUMBER from prow or a guid

• string name = 2

  Name associated with the column (such as the run/invocation ID). No two columns should have the same build_id and name. The name field allows the display of multiple columns with the same build_id.

• optional google.protobuf.Timestamp started = 3

  When the build started running

• repeated string extra = 4

  Additional custom headers like commit, image used, etc.

• string hotlist_ids = 5

  Custom hotlist ids.

Used in: Row

• int32 result = 1

• string cell_id = 2

• string message = 3

• string icon = 4

Used in: ListRowsResponse

• string name = 1

  Display name of the test case

• repeated Cell cells = 2

  Historical results of the test case. Unencoded.

• repeated string issues = 3

  Issue or Bug IDs associated with the test case

• optional state.AlertInfo alert = 4

  Alert associated with the test case

A Resource is a REST resource, often returned by a LIST command It includes the name of the resource and a link to the resource

Used in: GetDashboardGroupResponse, ListDashboardGroupsResponse, ListDashboardTabsResponse

• string name = 1

• string link = 2

Summary for a particular tab. Contains the info required to render tab summary in UI.

Used in: GetTabSummaryResponse, ListTabSummariesResponse

• string dashboard_name = 1

  The name of the dashboard this tab belongs to.

• string tab_name = 2

  The name of the tab.

• string overall_status = 3

  Overall status for the dashboard tab (e.g. PASSING, FAILING, etc.)

• string detailed_status_message = 4

  Summary of the status for this dashboard tab.

• optional google.protobuf.Timestamp last_run_timestamp = 5

  Timestamp at which tests last ran.

• optional google.protobuf.Timestamp last_update_timestamp = 6

  Timestamp at which the test group was last updated.

• string latest_passing_build = 7

  The ID for the latest passing build.

• optional FailuresSummary failures_summary = 8

  Summarized info on the failing tests. In this case, any test which raised an alert and did not suppress it is considered failing.

• optional HealthinessSummary healthiness_summary = 9

  Summarized info on the tab's healthiness.