Skip to content

Commit 71cdbae

Browse files
authored
coder_parameter: deprecate legacy_variable and legacy_variable_name (#126)
1 parent e381576 commit 71cdbae

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Diff for: docs/data-sources/parameter.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Use this data source to configure editable options for workspaces.
2525
- `description` (String) Describe what this parameter does.
2626
- `display_name` (String) The displayed name of the parameter as it will appear in the interface.
2727
- `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>"`.
28-
- `legacy_variable` (String) Reference to the Terraform variable. Coder will use it to lookup the default value.
29-
- `legacy_variable_name` (String) Name of the legacy Terraform variable. Coder will use it to lookup the variable value.
28+
- `legacy_variable` (String, Deprecated) Reference to the Terraform variable. Coder will use it to lookup the default value.
29+
- `legacy_variable_name` (String, Deprecated) Name of the legacy Terraform variable. Coder will use it to lookup the variable value.
3030
- `mutable` (Boolean) Whether this value can be changed after workspace creation. This can be destructive for values like region, so use with caution!
3131
- `option` (Block List, Max: 64) Each "option" block defines a value for a user to select from. (see [below for nested schema](#nestedblock--option))
3232
- `type` (String) The type of this parameter. Must be one of: "number", "string", "bool", or "list(string)".

Diff for: provider/parameter.go

+2
Original file line numberDiff line numberDiff line change
@@ -336,12 +336,14 @@ func parameterDataSource() *schema.Resource {
336336
Optional: true,
337337
RequiredWith: []string{"legacy_variable"},
338338
Description: "Name of the legacy Terraform variable. Coder will use it to lookup the variable value.",
339+
Deprecated: "Effective from Coder v0.24.0, the parameter migration feature is no longer available. This attribute will be removed in the nearest future.",
339340
},
340341
"legacy_variable": {
341342
Type: schema.TypeString,
342343
Optional: true,
343344
RequiredWith: []string{"legacy_variable_name"},
344345
Description: "Reference to the Terraform variable. Coder will use it to lookup the default value.",
346+
Deprecated: "Effective from Coder v0.24.0, the parameter migration feature is no longer available. This attribute will be removed in the nearest future.",
345347
},
346348
},
347349
}

0 commit comments

Comments
 (0)