Add example for add variable into library variable set

OctopusDeployLabs · Oct 3, 2024 · 0d48cc5 · 0d48cc5
1 parent d2f1fd3
commit 0d48cc5
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/docs/resources/variable.md b/docs/resources/variable.md
@@ -88,6 +88,14 @@ resource "octopusdeploy_variable" "prompted_variable" {
     label       = "Variable Label"
   }
 }
+
+# create a String variable to a library variable set
+resource "octopusdeploy_variable" "string_variable" {
+  owner_id  = "LibraryVariableSets-123"
+  type      = "String"
+  name      = "My String Value (OK to Delete)"
+  value     = "PlainText"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
@@ -103,7 +111,7 @@ resource "octopusdeploy_variable" "prompted_variable" {
 - `description` (String) The description of this variable.
 - `is_editable` (Boolean) Indicates whether or not this variable is considered editable.
 - `is_sensitive` (Boolean) Indicates whether or not this resource is considered sensitive and should be kept secret.
-- `owner_id` (String)
+- `owner_id` (String) Owner ID for the variable(e.g., project ID or library variable set ID)
 - `project_id` (String, Deprecated)
 - `prompt` (Block List) (see [below for nested schema](#nestedblock--prompt))
 - `scope` (Block List) (see [below for nested schema](#nestedblock--scope))

diff --git a/examples/resources/octopusdeploy_variable/resource.tf b/examples/resources/octopusdeploy_variable/resource.tf
@@ -74,3 +74,11 @@ resource "octopusdeploy_variable" "prompted_variable" {
     label       = "Variable Label"
   }
 }
+
+# create a String variable to a library variable set
+resource "octopusdeploy_variable" "string_variable" {
+  owner_id  = "LibraryVariableSets-123"
+  type      = "String"
+  name      = "My String Value (OK to Delete)"
+  value     = "PlainText"
+}
diff --git a/octopusdeploy_framework/schemas/variable.go b/octopusdeploy_framework/schemas/variable.go
@@ -145,7 +145,8 @@ func (v VariableSchema) GetResourceSchema() resourceSchema.Schema {
 			SchemaAttributeNames.Description: GetDescriptionResourceSchema(VariableResourceDescription),
 			SchemaAttributeNames.SpaceID:     GetSpaceIdResourceSchema(VariableResourceDescription),
 			VariableSchemaAttributeNames.OwnerID: resourceSchema.StringAttribute{
-				Optional: true,
+				Description: "Owner ID for the variable(e.g., project ID or library variable set ID)",
+				Optional:    true,
 				Validators: []validator.String{
 					stringvalidator.ConflictsWith(path.MatchRelative().AtParent().AtName(VariableSchemaAttributeNames.ProjectID)),
 				},