Skip to content

Commit 00342c8

Browse files
SBGoodsSBGoods
committed
Update comments to clarify usage
1 parent 73b007a commit 00342c8

14 files changed

+30
-114
lines changed

‎action/schema/bool_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,8 @@ type BoolAttribute struct {
105105
// are run in addition to the validation defined by the type.
106106
Validators []validator.Bool
107107

108-
// WriteOnly indicates that Terraform will not store this attribute value
109-
// in the plan or state artifacts.
110-
// If WriteOnly is true, either Optional or Required must also be true.
111-
// WriteOnly cannot be set with Computed.
112-
//
113-
// This functionality is only supported in Terraform 1.11 and later.
114-
// Practitioners that choose a value for this attribute with older
115-
// versions of Terraform will receive an error.
108+
// WriteOnly indicates whether this attribute can accept ephemeral values
109+
// or not. If WriteOnly is true, either Optional or Required must also be true.
116110
WriteOnly bool
117111
}
118112

‎action/schema/dynamic_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,14 +106,8 @@ type DynamicAttribute struct {
106106
// are run in addition to the validation defined by the type.
107107
Validators []validator.Dynamic
108108

109-
// WriteOnly indicates that Terraform will not store this attribute value
110-
// in the plan or state artifacts.
111-
// If WriteOnly is true, either Optional or Required must also be true.
112-
// WriteOnly cannot be set with Computed.
113-
//
114-
// This functionality is only supported in Terraform 1.11 and later.
115-
// Practitioners that choose a value for this attribute with older
116-
// versions of Terraform will receive an error.
109+
// WriteOnly indicates whether this attribute can accept ephemeral values
110+
// or not. If WriteOnly is true, either Optional or Required must also be true.
117111
WriteOnly bool
118112
}
119113

‎action/schema/float32_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,8 @@ type Float32Attribute struct {
108108
// are run in addition to the validation defined by the type.
109109
Validators []validator.Float32
110110

111-
// WriteOnly indicates that Terraform will not store this attribute value
112-
// in the plan or state artifacts.
113-
// If WriteOnly is true, either Optional or Required must also be true.
114-
// WriteOnly cannot be set with Computed.
115-
//
116-
// This functionality is only supported in Terraform 1.11 and later.
117-
// Practitioners that choose a value for this attribute with older
118-
// versions of Terraform will receive an error.
111+
// WriteOnly indicates whether this attribute can accept ephemeral values
112+
// or not. If WriteOnly is true, either Optional or Required must also be true.
119113
WriteOnly bool
120114
}
121115

‎action/schema/float64_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,8 @@ type Float64Attribute struct {
108108
// are run in addition to the validation defined by the type.
109109
Validators []validator.Float64
110110

111-
// WriteOnly indicates that Terraform will not store this attribute value
112-
// in the plan or state artifacts.
113-
// If WriteOnly is true, either Optional or Required must also be true.
114-
// WriteOnly cannot be set with Computed.
115-
//
116-
// This functionality is only supported in Terraform 1.11 and later.
117-
// Practitioners that choose a value for this attribute with older
118-
// versions of Terraform will receive an error.
111+
// WriteOnly indicates whether this attribute can accept ephemeral values
112+
// or not. If WriteOnly is true, either Optional or Required must also be true.
119113
WriteOnly bool
120114
}
121115

‎action/schema/int32_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,8 @@ type Int32Attribute struct {
108108
// are run in addition to the validation defined by the type.
109109
Validators []validator.Int32
110110

111-
// WriteOnly indicates that Terraform will not store this attribute value
112-
// in the plan or state artifacts.
113-
// If WriteOnly is true, either Optional or Required must also be true.
114-
// WriteOnly cannot be set with Computed.
115-
//
116-
// This functionality is only supported in Terraform 1.11 and later.
117-
// Practitioners that choose a value for this attribute with older
118-
// versions of Terraform will receive an error.
111+
// WriteOnly indicates whether this attribute can accept ephemeral values
112+
// or not. If WriteOnly is true, either Optional or Required must also be true.
119113
WriteOnly bool
120114
}
121115

‎action/schema/int64_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,8 @@ type Int64Attribute struct {
108108
// are run in addition to the validation defined by the type.
109109
Validators []validator.Int64
110110

111-
// WriteOnly indicates that Terraform will not store this attribute value
112-
// in the plan or state artifacts.
113-
// If WriteOnly is true, either Optional or Required must also be true.
114-
// WriteOnly cannot be set with Computed.
115-
//
116-
// This functionality is only supported in Terraform 1.11 and later.
117-
// Practitioners that choose a value for this attribute with older
118-
// versions of Terraform will receive an error.
111+
// WriteOnly indicates whether this attribute can accept ephemeral values
112+
// or not. If WriteOnly is true, either Optional or Required must also be true.
119113
WriteOnly bool
120114
}
121115

‎action/schema/list_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -124,14 +124,8 @@ type ListAttribute struct {
124124
// are run in addition to the validation defined by the type.
125125
Validators []validator.List
126126

127-
// WriteOnly indicates that Terraform will not store this attribute value
128-
// in the plan or state artifacts.
129-
// If WriteOnly is true, either Optional or Required must also be true.
130-
// WriteOnly cannot be set with Computed.
131-
//
132-
// This functionality is only supported in Terraform 1.11 and later.
133-
// Practitioners that choose a value for this attribute with older
134-
// versions of Terraform will receive an error.
127+
// WriteOnly indicates whether this attribute can accept ephemeral values
128+
// or not. If WriteOnly is true, either Optional or Required must also be true.
135129
WriteOnly bool
136130
}
137131

‎action/schema/list_nested_attribute.go‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -134,17 +134,11 @@ type ListNestedAttribute struct {
134134
// are run in addition to the validation defined by the type.
135135
Validators []validator.List
136136

137-
// WriteOnly indicates that Terraform will not store this attribute value
138-
// in the plan or state artifacts.
139-
// If WriteOnly is true, either Optional or Required must also be true.
140-
// WriteOnly cannot be set with Computed.
137+
// WriteOnly indicates whether this attribute can accept ephemeral values
138+
// or not. If WriteOnly is true, either Optional or Required must also be true.
141139
//
142140
// If WriteOnly is true for a nested attribute, all of its child attributes
143-
// must also set WriteOnly to true and no child attribute can be Computed.
144-
//
145-
// This functionality is only supported in Terraform 1.11 and later.
146-
// Practitioners that choose a value for this attribute with older
147-
// versions of Terraform will receive an error.
141+
// must also set WriteOnly to true.
148142
WriteOnly bool
149143
}
150144

‎action/schema/map_attribute.go‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,8 @@ type MapAttribute struct {
127127
// are run in addition to the validation defined by the type.
128128
Validators []validator.Map
129129

130-
// WriteOnly indicates that Terraform will not store this attribute value
131-
// in the plan or state artifacts.
132-
// If WriteOnly is true, either Optional or Required must also be true.
133-
// WriteOnly cannot be set with Computed.
134-
//
135-
// This functionality is only supported in Terraform 1.11 and later.
136-
// Practitioners that choose a value for this attribute with older
137-
// versions of Terraform will receive an error.
130+
// WriteOnly indicates whether this attribute can accept ephemeral values
131+
// or not. If WriteOnly is true, either Optional or Required must also be true.
138132
WriteOnly bool
139133
}
140134

‎action/schema/map_nested_attribute.go‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -134,17 +134,11 @@ type MapNestedAttribute struct {
134134
// are run in addition to the validation defined by the type.
135135
Validators []validator.Map
136136

137-
// WriteOnly indicates that Terraform will not store this attribute value
138-
// in the plan or state artifacts.
139-
// If WriteOnly is true, either Optional or Required must also be true.
140-
// WriteOnly cannot be set with Computed.
137+
// WriteOnly indicates whether this attribute can accept ephemeral values
138+
// or not. If WriteOnly is true, either Optional or Required must also be true.
141139
//
142140
// If WriteOnly is true for a nested attribute, all of its child attributes
143-
// must also set WriteOnly to true and no child attribute can be Computed.
144-
//
145-
// This functionality is only supported in Terraform 1.11 and later.
146-
// Practitioners that choose a value for this attribute with older
147-
// versions of Terraform will receive an error.
141+
// must also set WriteOnly to true.
148142
WriteOnly bool
149143
}
150144

0 commit comments

Comments
 (0)