coder · mtojek · Apr 3, 2023 · Mar 31, 2023 · Mar 31, 2023 · Mar 31, 2023
diff --git a/cli/cliui/parameter.go b/cli/cliui/parameter.go
@@ -62,7 +62,12 @@ func ParameterSchema(inv *clibase.Invocation, parameterSchema codersdk.Parameter
 }
 
 func RichParameter(inv *clibase.Invocation, templateVersionParameter codersdk.TemplateVersionParameter) (string, error) {
-	_, _ = fmt.Fprintln(inv.Stdout, Styles.Bold.Render(templateVersionParameter.Name))
+	label := templateVersionParameter.Name
+	if templateVersionParameter.DisplayName != "" {
+		label = templateVersionParameter.DisplayName
+	}
+
+	_, _ = fmt.Fprintln(inv.Stdout, Styles.Bold.Render(label))
 	if templateVersionParameter.DescriptionPlaintext != "" {
 		_, _ = fmt.Fprintln(inv.Stdout, "  "+strings.TrimSpace(strings.Join(strings.Split(templateVersionParameter.DescriptionPlaintext, "\n"), "\n  "))+"\n")
 	}

diff --git a/cli/create_test.go b/cli/create_test.go
@@ -366,6 +366,7 @@ func TestCreateWithRichParameters(t *testing.T) {
 		firstParameterValue       = "1"
 
 		secondParameterName        = "second_parameter"
+		secondParameterDisplayName = "Second Parameter"
 		secondParameterDescription = "This is second parameter"
 		secondParameterValue       = "2"
 
@@ -382,7 +383,7 @@ func TestCreateWithRichParameters(t *testing.T) {
 					Complete: &proto.Provision_Complete{
 						Parameters: []*proto.RichParameter{
 							{Name: firstParameterName, Description: firstParameterDescription, Mutable: true},
-							{Name: secondParameterName, Description: secondParameterDescription, Mutable: true},
+							{Name: secondParameterName, DisplayName: secondParameterDisplayName, Description: secondParameterDescription, Mutable: true},
 							{Name: immutableParameterName, Description: immutableParameterDescription, Mutable: false},
 						},
 					},
@@ -418,6 +419,7 @@ func TestCreateWithRichParameters(t *testing.T) {
 
 		matches := []string{
 			firstParameterDescription, firstParameterValue,
+			secondParameterDisplayName, "",
 			secondParameterDescription, secondParameterValue,
 			immutableParameterDescription, immutableParameterValue,
 			"Confirm create?", "yes",
@@ -426,7 +428,10 @@ func TestCreateWithRichParameters(t *testing.T) {
 			match := matches[i]
 			value := matches[i+1]
 			pty.ExpectMatch(match)
-			pty.WriteLine(value)
+
+			if value != "" {
+				pty.WriteLine(value)
+			}
 		}
 		<-doneChan
 	})

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbfake/databasefake.go b/coderd/database/dbfake/databasefake.go
@@ -2944,6 +2944,7 @@ func (q *fakeQuerier) InsertTemplateVersionParameter(_ context.Context, arg data
 	param := database.TemplateVersionParameter{
 		TemplateVersionID:   arg.TemplateVersionID,
 		Name:                arg.Name,
+		DisplayName:         arg.DisplayName,
 		Description:         arg.Description,
 		Type:                arg.Type,
 		Mutable:             arg.Mutable,

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000112_rich_parameter_display_name.down.sql b/coderd/database/migrations/000112_rich_parameter_display_name.down.sql
@@ -0,0 +1 @@
+ALTER TABLE template_version_parameters DROP COLUMN display_name;
diff --git a/coderd/database/migrations/000112_rich_parameter_display_name.up.sql b/coderd/database/migrations/000112_rich_parameter_display_name.up.sql
@@ -0,0 +1,4 @@
+ALTER TABLE template_version_parameters ADD COLUMN display_name text NOT NULL DEFAULT '';
+
+COMMENT ON COLUMN template_version_parameters.display_name
+IS 'Display name of the rich parameter';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templateversionparameters.sql b/coderd/database/queries/templateversionparameters.sql
@@ -15,7 +15,8 @@ INSERT INTO
         validation_error,
         validation_monotonic,
         required,
-        legacy_variable_name
+        legacy_variable_name,
+        display_name
     )
 VALUES
     (
@@ -33,7 +34,8 @@ VALUES
         $12,
         $13,
         $14,
-        $15
+        $15,
+		$16
     ) RETURNING *;
 
 -- name: GetTemplateVersionParameters :many

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -879,6 +879,7 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
 			_, err = server.Database.InsertTemplateVersionParameter(ctx, database.InsertTemplateVersionParameterParams{
 				TemplateVersionID:   input.TemplateVersionID,
 				Name:                richParameter.Name,
+				DisplayName:         richParameter.DisplayName,
 				Description:         richParameter.Description,
 				Type:                richParameter.Type,
 				Mutable:             richParameter.Mutable,

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -1596,6 +1596,7 @@ func convertTemplateVersionParameter(param database.TemplateVersionParameter) (c
 	}
 	return codersdk.TemplateVersionParameter{
 		Name:                 param.Name,
+		DisplayName:          param.DisplayName,
 		Description:          param.Description,
 		DescriptionPlaintext: descriptionPlaintext,
 		Type:                 param.Type,

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -1792,6 +1792,7 @@ func TestWorkspaceWithRichParameters(t *testing.T) {
 		firstParameterValue       = "1"
 
 		secondParameterName                = "second_parameter"
+		secondParameterDisplayName         = "Second Parameter"
 		secondParameterType                = "number"
 		secondParameterDescription         = "_This_ is second *parameter*"
 		secondParameterValue               = "2"
@@ -1814,6 +1815,7 @@ func TestWorkspaceWithRichParameters(t *testing.T) {
 							},
 							{
 								Name:                secondParameterName,
+								DisplayName:         secondParameterDisplayName,
 								Type:                secondParameterType,
 								Description:         secondParameterDescription,
 								ValidationMin:       1,
@@ -1850,6 +1852,7 @@ func TestWorkspaceWithRichParameters(t *testing.T) {
 	require.Equal(t, firstParameterDescriptionPlaintext, templateRichParameters[0].DescriptionPlaintext)
 	require.Equal(t, codersdk.ValidationMonotonicOrder(""), templateRichParameters[0].ValidationMonotonic) // no validation for string
 	require.Equal(t, secondParameterName, templateRichParameters[1].Name)
+	require.Equal(t, secondParameterDisplayName, templateRichParameters[1].DisplayName)
 	require.Equal(t, secondParameterType, templateRichParameters[1].Type)
 	require.Equal(t, secondParameterDescription, templateRichParameters[1].Description)
 	require.Equal(t, secondParameterDescriptionPlaintext, templateRichParameters[1].DescriptionPlaintext)

diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -41,6 +41,7 @@ const (
 // TemplateVersionParameter represents a parameter for a template version.
 type TemplateVersionParameter struct {
 	Name                 string                           `json:"name"`
+	DisplayName          string                           `json:"display_name,omitempty"`
 	Description          string                           `json:"description"`
 	DescriptionPlaintext string                           `json:"description_plaintext"`
 	Type                 string                           `json:"type" enums:"string,number,bool,list(string)"`

diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -3888,6 +3888,7 @@ Parameter represents a set value for the scope.
   "default_value": "string",
   "description": "string",
   "description_plaintext": "string",
+  "display_name": "string",
   "icon": "string",
   "legacy_variable_name": "string",
   "mutable": true,
@@ -3917,6 +3918,7 @@ Parameter represents a set value for the scope.
 | `default_value`         | string                                                                                      | false    |              |             |
 | `description`           | string                                                                                      | false    |              |             |
 | `description_plaintext` | string                                                                                      | false    |              |             |
+| `display_name`          | string                                                                                      | false    |              |             |
 | `icon`                  | string                                                                                      | false    |              |             |
 | `legacy_variable_name`  | string                                                                                      | false    |              |             |
 | `mutable`               | boolean                                                                                     | false    |              |             |

diff --git a/docs/api/templates.md b/docs/api/templates.md
@@ -2301,6 +2301,7 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/r
     "default_value": "string",
     "description": "string",
     "description_plaintext": "string",
+    "display_name": "string",
     "icon": "string",
     "legacy_variable_name": "string",
     "mutable": true,
@@ -2340,6 +2341,7 @@ Status Code **200**
 | `» default_value`         | string                                                                           | false    |              |             |
 | `» description`           | string                                                                           | false    |              |             |
 | `» description_plaintext` | string                                                                           | false    |              |             |
+| `» display_name`          | string                                                                           | false    |              |             |
 | `» icon`                  | string                                                                           | false    |              |             |
 | `» legacy_variable_name`  | string                                                                           | false    |              |             |
 | `» mutable`               | boolean                                                                          | false    |              |             |

diff --git a/go.mod b/go.mod
@@ -72,7 +72,7 @@ require (
 	github.com/codeclysm/extract v2.2.0+incompatible
 	github.com/coder/flog v1.1.0
 	github.com/coder/retry v1.3.1-0.20230210155434-e90a2e1e091d
-	github.com/coder/terraform-provider-coder v0.6.21
+	github.com/coder/terraform-provider-coder v0.6.23
 	github.com/coder/wgtunnel v0.1.5
 	github.com/coreos/go-oidc/v3 v3.4.0
 	github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf

diff --git a/go.sum b/go.sum
@@ -382,8 +382,8 @@ github.com/coder/ssh v0.0.0-20220811105153-fcea99919338 h1:tN5GKFT68YLVzJoA8AHui
 github.com/coder/ssh v0.0.0-20220811105153-fcea99919338/go.mod h1:ZSS+CUoKHDrqVakTfTWUlKSr9MtMFkC4UvtQKD7O914=
 github.com/coder/tailscale v1.1.1-0.20230329230537-76a675d945b7 h1:07rCDmnCKGG666bR0WI1grlI/RnI54xj0C+2d2gWeE4=
 github.com/coder/tailscale v1.1.1-0.20230329230537-76a675d945b7/go.mod h1:jpg+77g19FpXL43U1VoIqoSg1K/Vh5CVxycGldQ8KhA=
-github.com/coder/terraform-provider-coder v0.6.21 h1:TIH6+/VQFreT8q/CkRvpHtbIeM5cOAhuDS5Sh1Nm21Q=
-github.com/coder/terraform-provider-coder v0.6.21/go.mod h1:UIfU3bYNeSzJJvHyJ30tEKjD6Z9utloI+HUM/7n94CY=
+github.com/coder/terraform-provider-coder v0.6.23 h1:O2Rcj0umez4DfVdGnKZi63z1Xzxd0IQOn9VQDB8YU8g=
+github.com/coder/terraform-provider-coder v0.6.23/go.mod h1:UIfU3bYNeSzJJvHyJ30tEKjD6Z9utloI+HUM/7n94CY=
 github.com/coder/wgtunnel v0.1.5 h1:WP3sCj/3iJ34eKvpMQEp1oJHvm24RYh0NHbj1kfUKfs=
 github.com/coder/wgtunnel v0.1.5/go.mod h1:bokoUrHnUFY4lu9KOeSYiIcHTI2MO1KwqumU4DPDyJI=
 github.com/containerd/aufs v0.0.0-20200908144142-dab0cbea06f4/go.mod h1:nukgQABAEopAHvB6j7cnP5zJ+/3aVcE7hCYqvIwAHyE=

diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -471,6 +471,7 @@ func ConvertState(modules []*tfjson.StateModule, rawGraph string, rawParameterNa
 		}
 		protoParam := &proto.RichParameter{
 			Name:               param.Name,
+			DisplayName:        param.DisplayName,
 			Description:        param.Description,
 			Type:               param.Type,
 			Mutable:            param.Mutable,
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE template_version_parameters DROP COLUMN display_name;