Commit79d6ecd

authored

feat: Add display_name to coder_parameter (#118)

1 parentf0da725 commit79d6ecdCopy full SHA for 79d6ecd

File tree

+19

-7

lines changed

+19

-7

lines changed

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -17,12 +17,13 @@ Use this data source to configure editable options for workspaces.`
`17`	`17`
`18`	`18`	`###Required`
`19`	`19`
`20`		--`name` (String) The name of the parameter as it will appear in the interface. If this is changed, developers will be re-prompted for a new value.
	`20`	+-`name` (String) The name of the parameter. If this is changed, developers will be re-prompted for a new value.
`21`	`21`
`22`	`22`	`###Optional`
`23`	`23`
`24`	`24`	-`default` (String) A default value for the parameter.
`25`	`25`	-`description` (String) Describe what this parameter does.
	`26`	+-`display_name` (String) The displayed name of the parameter as it will appear in the interface.
`26`	`27`	-`icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here:https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with`data.coder_workspace.me.access_url + "/icon/<path>"`.
`27`	`28`	-`legacy_variable` (String) Reference to the Terraform variable. Coder will use it to lookup the default value.
`28`	`29`	-`legacy_variable_name` (String) Name of the legacy Terraform variable. Coder will use it to lookup the variable value.

Lines changed: 4 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,8 @@ data "coder_parameter" "fairy_tale" {`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`data"coder_parameter""users" {`
`80`		`-name="System users"`
`81`		`-type="list(string)"`
`82`		`-default=jsonencode(["root","user1","user2"])`
	`80`	`+name="system_users"`
	`81`	`+display_name="System users"`
	`82`	`+type="list(string)"`
	`83`	`+default=jsonencode(["root","user1","user2"])`
`83`	`84`	`}`

Lines changed: 9 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ const (`
`42`	`42`	`typeParameterstruct {`
`43`	`43`	`Valuestring`
`44`	`44`	`Namestring`
	`45`	`+DisplayNamestring`
`45`	`46`	`Descriptionstring`
`46`	`47`	`Typestring`
`47`	`48`	`Mutablebool`
`@@ -65,6 +66,7 @@ func parameterDataSource() *schema.Resource {`
`65`	`66`	`err:=mapstructure.Decode(struct {`
`66`	`67`	`Valueinterface{}`
`67`	`68`	`Nameinterface{}`
	`69`	`+DisplayNameinterface{}`
`68`	`70`	`Descriptioninterface{}`
`69`	`71`	`Typeinterface{}`
`70`	`72`	`Mutableinterface{}`
`@@ -79,6 +81,7 @@ func parameterDataSource() *schema.Resource {`
`79`	`81`	`}{`
`80`	`82`	`Value:rd.Get("value"),`
`81`	`83`	`Name:rd.Get("name"),`
	`84`	`+DisplayName:rd.Get("display_name"),`
`82`	`85`	`Description:rd.Get("description"),`
`83`	`86`	`Type:rd.Get("type"),`
`84`	`87`	`Mutable:rd.Get("mutable"),`
`@@ -170,7 +173,12 @@ func parameterDataSource() *schema.Resource {`
`170`	`173`	`"name": {`
`171`	`174`	`Type:schema.TypeString,`
`172`	`175`	`Required:true,`
`173`		`-Description:"The name of the parameter as it will appear in the interface. If this is changed, developers will be re-prompted for a new value.",`
	`176`	`+Description:"The name of the parameter. If this is changed, developers will be re-prompted for a new value.",`
	`177`	`+},`
	`178`	`+"display_name": {`
	`179`	`+Type:schema.TypeString,`
	`180`	`+Optional:true,`
	`181`	`+Description:"The displayed name of the parameter as it will appear in the interface.",`
`174`	`182`	`},`
`175`	`183`	`"description": {`
`176`	`184`	`Type:schema.TypeString,`

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@ func TestParameter(t *testing.T) {`
`22`	`22`	`Name:"FieldsExist",`
`23`	`23`	Config:`
`24`	`24`	`data "coder_parameter" "region" {`
`25`		`-name = "Region"`
	`25`	`+name = "region"`
	`26`	`+display_name = "Region"`
`26`	`27`	`type = "string"`
`27`	`28`	`description = <<-EOT`
`28`	`29`	`# Select the machine image`
`@@ -47,7 +48,8 @@ func TestParameter(t *testing.T) {`
`47`	`48`	`Check:func(state*terraform.ResourceState) {`
`48`	`49`	`attrs:=state.Primary.Attributes`
`49`	`50`	`forkey,value:=rangemap[string]interface{}{`
`50`		`-"name":"Region",`
	`51`	`+"name":"region",`
	`52`	`+"display_name":"Region",`
`51`	`53`	`"type":"string",`
`52`	`54`	`"description":"# Select the machine image\nSee the [registry](https://container.registry.blah/namespace) for options.\n",`
`53`	`55`	`"mutable":"true",`

Comments

(0)