Skip to content

Commit f2c04b2

Browse files
SBGoodsSBGoods
committed
Update wording of IsWriteOnly comment for ephemeral/schema, provider/schema, and provider/metaschema 
1 parent 428efef commit f2c04b2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+108
-54
lines changed

‎ephemeral/schema/bool_attribute.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,8 @@ func (a BoolAttribute) IsSensitive() bool {
185185
return a.Sensitive
186186
}
187187

188-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
188+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
189+
// as these schemas describe data that is explicitly not saved to any artifact.
189190
func (a BoolAttribute) IsWriteOnly() bool {
190191
return false
191192
}

‎ephemeral/schema/dynamic_attribute.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
package schema
55

66
import (
7+
"github.com/hashicorp/terraform-plugin-go/tftypes"
8+
79
"github.com/hashicorp/terraform-plugin-framework/attr"
810
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
911
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
1012
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
1113
"github.com/hashicorp/terraform-plugin-framework/types"
1214
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
13-
"github.com/hashicorp/terraform-plugin-go/tftypes"
1415
)
1516

1617
// Ensure the implementation satisifies the desired interfaces.
@@ -180,7 +181,8 @@ func (a DynamicAttribute) IsSensitive() bool {
180181
return a.Sensitive
181182
}
182183

183-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
184+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
185+
// as these schemas describe data that is explicitly not saved to any artifact.
184186
func (a DynamicAttribute) IsWriteOnly() bool {
185187
return false
186188
}

‎ephemeral/schema/float32_attribute.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,8 @@ func (a Float32Attribute) IsSensitive() bool {
188188
return a.Sensitive
189189
}
190190

191-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
191+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
192+
// as these schemas describe data that is explicitly not saved to any artifact.
192193
func (a Float32Attribute) IsWriteOnly() bool {
193194
return false
194195
}

‎ephemeral/schema/float64_attribute.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
package schema
55

66
import (
7+
"github.com/hashicorp/terraform-plugin-go/tftypes"
8+
79
"github.com/hashicorp/terraform-plugin-framework/attr"
810
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
911
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
1012
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
1113
"github.com/hashicorp/terraform-plugin-framework/types"
1214
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
13-
"github.com/hashicorp/terraform-plugin-go/tftypes"
1415
)
1516

1617
// Ensure the implementation satisifies the desired interfaces.
@@ -187,7 +188,8 @@ func (a Float64Attribute) IsSensitive() bool {
187188
return a.Sensitive
188189
}
189190

190-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
191+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
192+
// as these schemas describe data that is explicitly not saved to any artifact.
191193
func (a Float64Attribute) IsWriteOnly() bool {
192194
return false
193195
}

‎ephemeral/schema/int32_attribute.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,8 @@ func (a Int32Attribute) IsSensitive() bool {
188188
return a.Sensitive
189189
}
190190

191-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
191+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
192+
// as these schemas describe data that is explicitly not saved to any artifact.
192193
func (a Int32Attribute) IsWriteOnly() bool {
193194
return false
194195
}

‎ephemeral/schema/int64_attribute.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@
44
package schema
55

66
import (
7+
"github.com/hashicorp/terraform-plugin-go/tftypes"
8+
79
"github.com/hashicorp/terraform-plugin-framework/attr"
810
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
911
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
1012
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
1113
"github.com/hashicorp/terraform-plugin-framework/types"
1214
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
13-
"github.com/hashicorp/terraform-plugin-go/tftypes"
1415
)
1516

1617
// Ensure the implementation satisifies the desired interfaces.
@@ -187,7 +188,8 @@ func (a Int64Attribute) IsSensitive() bool {
187188
return a.Sensitive
188189
}
189190

190-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
191+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
192+
// as these schemas describe data that is explicitly not saved to any artifact.
191193
func (a Int64Attribute) IsWriteOnly() bool {
192194
return false
193195
}

‎ephemeral/schema/list_attribute.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ package schema
66
import (
77
"context"
88

9+
"github.com/hashicorp/terraform-plugin-go/tftypes"
10+
911
"github.com/hashicorp/terraform-plugin-framework/attr"
1012
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
1113
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
1214
"github.com/hashicorp/terraform-plugin-framework/internal/fwtype"
1315
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
1416
"github.com/hashicorp/terraform-plugin-framework/types"
1517
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
16-
"github.com/hashicorp/terraform-plugin-go/tftypes"
1718
)
1819

1920
// Ensure the implementation satisifies the desired interfaces.
@@ -199,7 +200,8 @@ func (a ListAttribute) IsSensitive() bool {
199200
return a.Sensitive
200201
}
201202

202-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
203+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
204+
// as these schemas describe data that is explicitly not saved to any artifact.
203205
func (a ListAttribute) IsWriteOnly() bool {
204206
return false
205207
}

‎ephemeral/schema/list_nested_attribute.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ import (
77
"context"
88
"fmt"
99

10+
"github.com/hashicorp/terraform-plugin-go/tftypes"
11+
1012
"github.com/hashicorp/terraform-plugin-framework/attr"
1113
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
1214
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
1315
"github.com/hashicorp/terraform-plugin-framework/internal/fwtype"
1416
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
1517
"github.com/hashicorp/terraform-plugin-framework/types"
1618
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
17-
"github.com/hashicorp/terraform-plugin-go/tftypes"
1819
)
1920

2021
// Ensure the implementation satisifies the desired interfaces.
@@ -228,7 +229,8 @@ func (a ListNestedAttribute) IsSensitive() bool {
228229
return a.Sensitive
229230
}
230231

231-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
232+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
233+
// as these schemas describe data that is explicitly not saved to any artifact.
232234
func (a ListNestedAttribute) IsWriteOnly() bool {
233235
return false
234236
}

‎ephemeral/schema/map_attribute.go‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,15 @@ package schema
66
import (
77
"context"
88

9+
"github.com/hashicorp/terraform-plugin-go/tftypes"
10+
911
"github.com/hashicorp/terraform-plugin-framework/attr"
1012
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
1113
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
1214
"github.com/hashicorp/terraform-plugin-framework/internal/fwtype"
1315
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
1416
"github.com/hashicorp/terraform-plugin-framework/types"
1517
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
16-
"github.com/hashicorp/terraform-plugin-go/tftypes"
1718
)
1819

1920
// Ensure the implementation satisifies the desired interfaces.
@@ -203,7 +204,8 @@ func (a MapAttribute) IsSensitive() bool {
203204
return a.Sensitive
204205
}
205206

206-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
207+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
208+
// as these schemas describe data that is explicitly not saved to any artifact.
207209
func (a MapAttribute) IsWriteOnly() bool {
208210
return false
209211
}

‎ephemeral/schema/map_nested_attribute.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,8 @@ func (a MapNestedAttribute) IsSensitive() bool {
229229
return a.Sensitive
230230
}
231231

232-
// IsWriteOnly returns false as write-only attributes are not supported in ephemeral resource schemas.
232+
// IsWriteOnly returns false as write-only attributes are not relevant to ephemeral resource schemas,
233+
// as these schemas describe data that is explicitly not saved to any artifact.
233234
func (a MapNestedAttribute) IsWriteOnly() bool {
234235
return false
235236
}

0 commit comments

Comments
 (0)