Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update config var description docs #160

Merged
merged 3 commits into from
Nov 1, 2021
Merged

Update config var description docs #160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44daa91
added description
Nov 1, 2021
d2ec179
docs
Nov 1, 2021
66d474e
another update
Nov 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/data-sources/configuration_variable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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


8 changes: 5 additions & 3 deletions docs/resources/configuration_variable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" {
Expand All @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does it mean? a boolean variable? do you think it's clear enough?

Copy link
Member Author

@eranelbaz eranelbaz Nov 1, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the value of the variable and it is sensitive, meaning it is string but you won't get the value
we just didn't update the docs apparently before


### Optional

- **description** (String) a description of the variables
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add that we limit it to 255 chars

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

66d474e

- **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.
Expand Down
5 changes: 3 additions & 2 deletions examples/resources/env0_configuration_variable/resource.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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" {
Expand Down