From 56589b9d1fd4f2750242eb951fc049497f2387bf Mon Sep 17 00:00:00 2001
From: Jason Harley <jason@honeycomb.io>
Date: Thu, 14 Sep 2023 10:14:22 -0400
Subject: [PATCH] Deprecate list-style Boards (#365)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Today's Board announcements prompted me to deprecate the `style`
attribute on Boards to update the behaviour to match both the product
and the API.

All Boards are `visual` now ✨
---
 client/board.go                        |  3 +-
 docs/resources/board.md                |  7 ++---
 example/board/main.tf                  |  1 -
 example/board_with_annotations/main.tf |  1 -
 honeycombio/resource_board.go          | 42 +++++++++++++++++---------
 honeycombio/resource_board_test.go     | 21 +------------
 6 files changed, 33 insertions(+), 42 deletions(-)

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 = <<EOT
 Helpful queries to get an overview of our service overall health and performance.
 Useful as a jumping off point for BubbleUp or a quick investigation.
diff --git a/honeycombio/resource_board.go b/honeycombio/resource_board.go
index 6124e12c..4ca97b20 100644
--- a/honeycombio/resource_board.go
+++ b/honeycombio/resource_board.go
@@ -24,45 +24,54 @@ func newBoard() *schema.Resource {
 			"name": {
 				Type:         schema.TypeString,
 				Required:     true,
+				Description:  "The name of the Board.",
 				ValidateFunc: validation.StringLenBetween(1, 255),
 			},
 			"description": {
 				Type:         schema.TypeString,
 				Optional:     true,
+				Description:  "A description for the Board. Supports Markdown.",
 				ValidateFunc: validation.StringLenBetween(1, 1023),
 			},
 			"column_layout": {
 				Type:         schema.TypeString,
 				Optional:     true,
 				Computed:     true,
+				Description:  "The number of columns to layout on the Board.",
 				ValidateFunc: validation.StringInSlice([]string{"multi", "single"}, false),
 			},
 			"style": {
 				Type:         schema.TypeString,
 				Optional:     true,
-				Default:      "list",
+				Default:      "visual",
+				Description:  "How the Board should be displayed in the UI.",
+				Deprecated:   "All Boards now are displayed visually in the UI. Setting this value will have no effect.",
 				ValidateFunc: validation.StringInSlice(boardStyleStrings(), false),
 			},
 			"board_url": {
-				Type:     schema.TypeString,
-				Required: false,
-				Optional: false,
-				Computed: true,
+				Type:        schema.TypeString,
+				Description: "The URL to the Board in the Honeycomb UI.",
+				Required:    false,
+				Optional:    false,
+				Computed:    true,
 			},
 			"query": {
-				Type:     schema.TypeList,
-				Optional: true,
+				Type:        schema.TypeList,
+				Optional:    true,
+				Description: "A Query to be added to the Board.",
 				Elem: &schema.Resource{
 					Schema: map[string]*schema.Schema{
 						"caption": {
 							Type:         schema.TypeString,
 							Optional:     true,
+							Description:  "Descriptive text to contextualize the Query within the Board. Supports Markdown.",
 							ValidateFunc: validation.StringLenBetween(1, 1023),
 						},
 						"query_style": {
 							Type:         schema.TypeString,
 							Optional:     true,
 							Computed:     true,
+							Description:  "How the Query should be displayed within the Board.",
 							ValidateFunc: validation.StringInSlice(boardQueryStyleStrings(), false),
 						},
 						"graph_settings": {
@@ -115,18 +124,21 @@ See [Graph Settings](https://docs.honeycomb.io/working-with-your-data/graph-sett
 							},
 						},
 						"dataset": {
-							Type:       schema.TypeString,
-							Optional:   true,
-							Computed:   true,
-							Deprecated: "Board Queries no longer require the dataset as they rely on the provided Query ID's dataset.",
+							Type:        schema.TypeString,
+							Optional:    true,
+							Computed:    true,
+							Description: "The Dataset this Query is associated with.",
+							Deprecated:  "Board Queries no longer require the dataset as they rely on the provided Query ID's dataset.",
 						},
 						"query_id": {
-							Type:     schema.TypeString,
-							Required: true,
+							Type:        schema.TypeString,
+							Required:    true,
+							Description: "The ID of the Query to run.",
 						},
 						"query_annotation_id": {
-							Type:     schema.TypeString,
-							Optional: true,
+							Type:        schema.TypeString,
+							Optional:    true,
+							Description: "The ID of the Query Annotation to associate with this Query.",
 						},
 					},
 				},
diff --git a/honeycombio/resource_board_test.go b/honeycombio/resource_board_test.go
index 432bc2ce..2f0cf436 100644
--- a/honeycombio/resource_board_test.go
+++ b/honeycombio/resource_board_test.go
@@ -3,7 +3,6 @@ package honeycombio
 import (
 	"context"
 	"fmt"
-	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -22,7 +21,7 @@ func TestAccHoneycombioBoard_basic(t *testing.T) {
 				Check: resource.ComposeTestCheckFunc(
 					testAccCheckBoardExists(t, "honeycombio_board.test"),
 					resource.TestCheckResourceAttr("honeycombio_board.test", "name", "Test board from terraform-provider-honeycombio"),
-					resource.TestCheckResourceAttr("honeycombio_board.test", "style", "list"),
+					resource.TestCheckResourceAttr("honeycombio_board.test", "style", "visual"),
 					resource.TestCheckResourceAttr("honeycombio_board.test", "description", ""),
 					resource.TestCheckResourceAttr("honeycombio_board.test", "query.#", "2"),
 					resource.TestCheckResourceAttr("honeycombio_board.test", "query.0.caption", "test query 0"),
@@ -62,7 +61,6 @@ resource "honeycombio_query" "test" {
 
 resource "honeycombio_board" "test" {
   name          = "simple board"
-  style         = "visual"
   column_layout = "single"
 
   query {
@@ -85,22 +83,6 @@ resource "honeycombio_board" "test" {
 			},
 		},
 	})
-	resource.Test(t, resource.TestCase{
-		PreCheck:          testAccPreCheck(t),
-		ProviderFactories: testAccProviderFactories,
-		Steps: []resource.TestStep{
-			{
-				Config: `
-resource "honeycombio_board" "test" {
-  name          = "error board"
-  style         = "list"
-  column_layout = "multi"
-}
-`,
-				ExpectError: regexp.MustCompile(`list style boards cannot specify a column layout`),
-			},
-		},
-	})
 }
 
 func testAccBoardConfig(dataset string) string {
@@ -140,7 +122,6 @@ resource "honeycombio_query_annotation" "test" {
 
 resource "honeycombio_board" "test" {
   name  = "Test board from terraform-provider-honeycombio"
-  style = "list"
 
   query {
     caption             = "test query 0"