test: parameter description contains Markdown

mtojek · mtojek · commit 5524c10d0157 · 2023-02-07T15:35:49.000+01:00
diff --git a/examples/resources/coder_parameter/resource.tf b/examples/resources/coder_parameter/resource.tf
@@ -17,9 +17,8 @@ data "coder_parameter" "example" {
 
 data "coder_parameter" "ami" {
   name = "Machine Image"
-  description = "Provide the machine image."
-  description_markdown = <<-EOT
-    # Select the machine image
+  description = <<-EOT
+    # Provide the machine image
     See the [registry](https://container.registry.blah/namespace) for options.
     EOT
   option {
diff --git a/provider/parameter.go b/provider/parameter.go
@@ -39,16 +39,15 @@ const (
 )
 
 type Parameter struct {
-	Value               string
-	Name                string
-	Description         string
-	DescriptionMarkdown string
-	Type                string
-	Mutable             bool
-	Default             string
-	Icon                string
-	Option              []Option
-	Validation          []Validation
+	Value       string
+	Name        string
+	Description string
+	Type        string
+	Mutable     bool
+	Default     string
+	Icon        string
+	Option      []Option
+	Validation  []Validation
 }
 
 func parameterDataSource() *schema.Resource {
@@ -59,27 +58,25 @@ func parameterDataSource() *schema.Resource {
 
 			var parameter Parameter
 			err := mapstructure.Decode(struct {
-				Value               interface{}
-				Name                interface{}
-				Description         interface{}
-				DescriptionMarkdown interface{}
-				Type                interface{}
-				Mutable             interface{}
-				Default             interface{}
-				Icon                interface{}
-				Option              interface{}
-				Validation          interface{}
+				Value       interface{}
+				Name        interface{}
+				Description interface{}
+				Type        interface{}
+				Mutable     interface{}
+				Default     interface{}
+				Icon        interface{}
+				Option      interface{}
+				Validation  interface{}
 			}{
-				Value:               rd.Get("value"),
-				Name:                rd.Get("name"),
-				Description:         rd.Get("description"),
-				DescriptionMarkdown: rd.Get("description_markdown"),
-				Type:                rd.Get("type"),
-				Mutable:             rd.Get("mutable"),
-				Default:             rd.Get("default"),
-				Icon:                rd.Get("icon"),
-				Option:              rd.Get("option"),
-				Validation:          rd.Get("validation"),
+				Value:       rd.Get("value"),
+				Name:        rd.Get("name"),
+				Description: rd.Get("description"),
+				Type:        rd.Get("type"),
+				Mutable:     rd.Get("mutable"),
+				Default:     rd.Get("default"),
+				Icon:        rd.Get("icon"),
+				Option:      rd.Get("option"),
+				Validation:  rd.Get("validation"),
 			}, &parameter)
 			if err != nil {
 				return diag.Errorf("decode parameter: %s", err)
@@ -145,11 +142,6 @@ func parameterDataSource() *schema.Resource {
 				Optional:    true,
 				Description: "Describe what this parameter does.",
 			},
-			"description_markdown": {
-				Type:        schema.TypeString,
-				Optional:    true,
-				Description: "Alternative description with Markdown tags.",
-			},
 			"type": {
 				Type:         schema.TypeString,
 				Default:      "string",
diff --git a/provider/parameter_test.go b/provider/parameter_test.go
@@ -24,8 +24,7 @@ func TestParameter(t *testing.T) {
 data "coder_parameter" "region" {
 	name = "Region"
 	type = "string"
-	description = "Some option!"
-	description_markdown = <<-EOT
+	description = <<-EOT
 		# Select the machine image
 		See the [registry](https://container.registry.blah/namespace) for options.
 		EOT
@@ -50,8 +49,7 @@ data "coder_parameter" "region" {
 			for key, value := range map[string]interface{}{
 				"name":                 "Region",
 				"type":                 "string",
-				"description":          "Some option!",
-				"description_markdown": "# Select the machine image\nSee the [registry](https://container.registry.blah/namespace) for options.\n",
+				"description":          "# Select the machine image\nSee the [registry](https://container.registry.blah/namespace) for options.\n",
 				"mutable":              "true",
 				"icon":                 "/icon/region.svg",
 				"option.0.name":        "US Central",
