Update config var description docs (#160)

env0 · Nov 1, 2021 · 81f8649 · 81f8649
1 parent dcfbd50
commit 81f8649
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/docs/data-sources/configuration_variable.md b/docs/data-sources/configuration_variable.md
@@ -28,6 +28,7 @@ output "aws_default_region" {
 ### Optional
 
 - **deployment_log_id** (String) search for the variable under this deployment log, not globally
+- **description** (String) a description of the variable
 - **environment_id** (String) search for the variable under this environment, not globally
 - **id** (String) id of the configuration variable
 - **name** (String) the name of the configuration variable
@@ -40,6 +41,6 @@ output "aws_default_region" {
 - **enum** (List of String) possible values of this variable
 - **is_sensitive** (Boolean) is the variable defined as sensitive
 - **scope** (String) scope of the variable
-- **value** (String) value stored in the variable
+- **value** (String, Sensitive) value stored in the variable
 
 
diff --git a/docs/resources/configuration_variable.md b/docs/resources/configuration_variable.md
@@ -14,8 +14,9 @@ description: |-
 
 ```terraform
 resource "env0_configuration_variable" "example" {
-  name  = "ENVIRONMENT_VARIABLE_NAME"
-  value = "example value"
+  name        = "ENVIRONMENT_VARIABLE_NAME"
+  value       = "example value"
+  description = "Here you can fill description for this variable, note this field have limit of 255 chars"
 }
 
 resource "env0_configuration_variable" "drop_down" {
@@ -34,10 +35,11 @@ resource "env0_configuration_variable" "drop_down" {
 ### Required
 
 - **name** (String) name to give the configuration variable
-- **value** (String) value for the configuration variable
+- **value** (String, Sensitive) value for the configuration variable
 
 ### Optional
 
+- **description** (String) a description of the variables
 - **enum** (List of String) limit possible values to values from this list
 - **environment_id** (String) create the variable under this environment, not globally
 - **id** (String) The ID of this resource.

diff --git a/examples/resources/env0_configuration_variable/resource.tf b/examples/resources/env0_configuration_variable/resource.tf
@@ -1,6 +1,7 @@
 resource "env0_configuration_variable" "example" {
-  name  = "ENVIRONMENT_VARIABLE_NAME"
-  value = "example value"
+  name        = "ENVIRONMENT_VARIABLE_NAME"
+  value       = "example value"
+  description = "Here you can fill description for this variable, note this field have limit of 255 chars"
 }
 
 resource "env0_configuration_variable" "drop_down" {