diff --git a/client/board.go b/client/board.go index f34a4e6d..dd2a54b0 100644 --- a/client/board.go +++ b/client/board.go @@ -51,7 +51,8 @@ type Board struct { // // n.b. 'list' style boards cannot specify a column layout ColumnLayout BoardColumnStyle `json:"column_layout,omitempty"` - // How the board should be displayed in the UI, defaults to "list". + // How the board should be displayed in the UI, defaults to "visual". + // Deprecated: All Boards are visual now. This field is ignored. Style BoardStyle `json:"style,omitempty"` // Links returned by the board API for the Board Links BoardLinks `json:"links,omitempty"` diff --git a/docs/resources/board.md b/docs/resources/board.md index 72d9596b..2a09a89b 100644 --- a/docs/resources/board.md +++ b/docs/resources/board.md @@ -78,7 +78,6 @@ resource "honeycombio_query_annotation" "latency_by_userid" { resource "honeycombio_board" "overview" { name = "Service Overview" - style = "visual" query { caption = "Latency by User" @@ -97,9 +96,9 @@ resource "honeycombio_board" "overview" { The following arguments are supported: * `name` - (Required) Name of the board. -* `description` - (Optional) Description of the board. Supports markdown. +* `description` - (Optional) Description of the board. Supports Markdown. * `column_layout` - (Optional) the number of columns to layout on the board, either `multi` (the default) or `single`. Only `visual` style boards (see below) have a column layout. -* `style` - (Optional) How the board should be displayed in the UI, either `list` (the default) or `visual`. +* `style` - (Optional) Deprecated: All Boards are now displayed as `visual` style. How the board should be displayed in the UI, either `visual` (the default) or `list`. * `query` - (Optional) Zero or more configurations blocks (described below) with the queries of the board. Each board configuration may have zero or more `query` blocks, which accepts the following arguments: @@ -107,7 +106,7 @@ Each board configuration may have zero or more `query` blocks, which accepts the * `query_id` - (Required) The ID of the Query to run. * `query_annotation_id` - (Optional) The ID of the Query Annotation to associate with this query. * `dataset` - (Deprecated) The dataset this query is associated with. -* `caption` - (Optional) A description of the query that will be displayed on the board. Supports markdown. +* `caption` - (Optional) Descriptive text to contextualize the Query within the Board. Supports Markdown. * `graph_settings` - (Optional) A map of boolean toggles to manages the settings for this query's graph on the board. If a value is unspecified, it is assumed to be false. Currently supported toggles are: diff --git a/example/board/main.tf b/example/board/main.tf index c5b65e82..7d6be1fd 100644 --- a/example/board/main.tf +++ b/example/board/main.tf @@ -37,7 +37,6 @@ resource "honeycombio_query" "query" { resource "honeycombio_board" "board" { name = "Request Latency" description = "Latencies of all requests by Tenant for the last 15 minutes." - style = "list" query { caption = "Latency" diff --git a/example/board_with_annotations/main.tf b/example/board_with_annotations/main.tf index 1129623c..a8f8f8c1 100644 --- a/example/board_with_annotations/main.tf +++ b/example/board_with_annotations/main.tf @@ -50,7 +50,6 @@ resource "honeycombio_query_annotation" "latency_by_userid" { resource "honeycombio_board" "overview" { name = "Service Overview" - style = "visual" description = <