Skip to content

Commit 1fdf154

Browse files
bfladbflad
authored
website: Replace interface{} with any (#1029)
Reference: #834 Updates the website documentation to use Go 1.18+ `any` instead of an empty interface (`interface{}`) as the latter can be confusing to those unfamiliar with Go. Code updates within this Go module can be refactored at some other point, if necessary or desired.
1 parent 7f4847b commit 1fdf154

File tree

13 files changed

+61
-61
lines changed

13 files changed

+61
-61
lines changed

‎website/docs/plugin/sdkv2/best-practices/deprecations.mdx

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ func resourceExampleWidget() *schema.Resource {
9696
}
9797
}
9898

99-
func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
99+
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
100100
// ... other logic ...
101101

102102
existingAttribute := d.Get("existing_attribute").(string)
@@ -106,7 +106,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
106106
return resourceExampleWidgetRead(d, meta)
107107
}
108108

109-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
109+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
110110
// ... other logic ...
111111

112112
d.Set("existing_attribute", /* ... */)
@@ -115,7 +115,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
115115
return nil
116116
}
117117

118-
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
118+
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
119119
// ... other logic ...
120120

121121
existingAttribute := d.Get("existing_attribute").(string)
@@ -155,7 +155,7 @@ func resourceExampleWidget() *schema.Resource {
155155
}
156156
}
157157

158-
func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
158+
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
159159
// ... other logic ...
160160

161161
existingAttribute, existingAttributeOk := d.GetOk("existing_attribute")
@@ -173,7 +173,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
173173
return resourceExampleWidgetRead(d, meta)
174174
}
175175

176-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
176+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
177177
// ... other logic ...
178178

179179
if _, ok := d.GetOk("existing_attribute"); ok {
@@ -186,7 +186,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
186186
return nil
187187
}
188188

189-
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
189+
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
190190
// ... other logic ...
191191

192192
existingAttribute, existingAttributeOk := d.GetOk("existing_attribute")
@@ -227,7 +227,7 @@ func resourceExampleWidget() *schema.Resource {
227227
}
228228
}
229229

230-
func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
230+
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
231231
// ... other logic ...
232232

233233
newAttribute := d.Get("new_attribute").(string)
@@ -237,7 +237,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
237237
return resourceExampleWidgetRead(d, meta)
238238
}
239239

240-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
240+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
241241
// ... other logic ...
242242

243243
d.Set("new_attribute", /* ... */)
@@ -246,7 +246,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
246246
return nil
247247
}
248248

249-
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
249+
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
250250
// ... other logic ...
251251

252252
newAttribute := d.Get("new_attribute").(string)
@@ -304,7 +304,7 @@ func resourceExampleWidget() *schema.Resource {
304304
}
305305
}
306306

307-
func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
307+
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
308308
// ... other logic ...
309309

310310
if v, ok := d.GetOk("existing_attribute"); ok {
@@ -315,7 +315,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
315315
return resourceExampleWidgetRead(d, meta)
316316
}
317317

318-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
318+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
319319
// ... other logic ...
320320

321321
d.Set("existing_attribute", /* ... */)
@@ -324,7 +324,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
324324
return nil
325325
}
326326

327-
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
327+
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
328328
// ... other logic ...
329329

330330
if v, ok := d.GetOk("existing_attribute"); ok {
@@ -365,7 +365,7 @@ func resourceExampleWidget() *schema.Resource {
365365
}
366366
}
367367

368-
func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
368+
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
369369
// ... other logic ...
370370

371371
if v, ok := d.GetOk("existing_attribute"); ok {
@@ -378,7 +378,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
378378
return resourceExampleWidgetRead(d, meta)
379379
}
380380

381-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
381+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
382382
// ... other logic ...
383383

384384
if v, ok := d.GetOk("existing_attribute"); ok {
@@ -391,7 +391,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
391391
return nil
392392
}
393393

394-
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
394+
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
395395
// ... other logic ...
396396

397397
if v, ok := d.GetOk("existing_attribute"); ok {
@@ -427,7 +427,7 @@ func resourceExampleWidget() *schema.Resource {
427427
}
428428
}
429429

430-
func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error {
430+
func resourceExampleWidgetCreate(d *schema.ResourceData, meta any) error {
431431
// ... other logic ...
432432

433433
if v, ok := d.GetOk("new_attribute"); ok {
@@ -438,7 +438,7 @@ func resourceExampleWidgetCreate(d *schema.ResourceData, meta interface{}) error
438438
return resourceExampleWidgetRead(d, meta)
439439
}
440440

441-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
441+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
442442
// ... other logic ...
443443

444444
d.Set("new_attribute", /* ... */)
@@ -447,7 +447,7 @@ func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
447447
return nil
448448
}
449449

450-
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta interface{}) error {
450+
func resourceExampleWidgetUpdate(d *schema.ResourceData, meta any) error {
451451
// ... other logic ...
452452

453453
if v, ok := d.GetOk("new_attribute"); ok {
@@ -494,7 +494,7 @@ func resourceExampleWidget() *schema.Resource {
494494
}
495495
}
496496

497-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
497+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
498498
// ... other logic ...
499499

500500
d.Set("existing_attribute", /* ... */)
@@ -529,7 +529,7 @@ func resourceExampleWidget() *schema.Resource {
529529
}
530530
}
531531

532-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
532+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
533533
// ... other logic ...
534534

535535
d.Set("existing_attribute", /* ... */)
@@ -560,7 +560,7 @@ func resourceExampleWidget() *schema.Resource {
560560
}
561561
}
562562

563-
func resourceExampleWidgetRead(d *schema.ResourceData, meta interface{}) error {
563+
func resourceExampleWidgetRead(d *schema.ResourceData, meta any) error {
564564
// ... other logic ...
565565

566566
d.Set("new_attribute", /* ... */)
@@ -647,10 +647,10 @@ func resourceExampleWidget() *schema.Resource {
647647
return &schema.Resource{
648648
// ... other configuration ...
649649

650-
Create: func(d *schema.ResourceData, meta interface{}) error {
650+
Create: func(d *schema.ResourceData, meta any) error {
651651
return errors.New("use example_thing resource instead")
652652
},
653-
Read: func(d *schema.ResourceData, meta interface{}) error {
653+
Read: func(d *schema.ResourceData, meta any) error {
654654
return errors.New("use example_thing resource instead")
655655
},
656656
}
@@ -759,10 +759,10 @@ func resourceExampleExistingWidget() *schema.Resource {
759759
return &schema.Resource{
760760
// ... other configuration ...
761761

762-
Create: func(d *schema.ResourceData, meta interface{}) error {
762+
Create: func(d *schema.ResourceData, meta any) error {
763763
return errors.New("use example_new_widget resource instead")
764764
},
765-
Read: func(d *schema.ResourceData, meta interface{}) error {
765+
Read: func(d *schema.ResourceData, meta any) error {
766766
return errors.New("use example_new_widget resource instead")
767767
},
768768
}

‎website/docs/plugin/sdkv2/best-practices/detecting-drift.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ func resourceExampleSimple() *schema.Resource {
4949
}
5050
}
5151

52-
func resourceExampleSimpleRead(d *schema.ResourceData, meta interface{}) error {
52+
func resourceExampleSimpleRead(d *schema.ResourceData, meta any) error {
5353
client := meta.(*ProviderApi).client
5454
resource, _ := client.GetResource(d.Id())
5555
d.Set("name", resource.Name)
@@ -97,15 +97,15 @@ reconcile the diff. Because of this, it is standard practice to call `READ` at
9797
the end of all modifications to synchronize immediately and avoid that diff.
9898

9999
```go
100-
func resourceExampleSimpleRead(d *schema.ResourceData, meta interface{}) error {
100+
func resourceExampleSimpleRead(d *schema.ResourceData, meta any) error {
101101
client := meta.(*ProviderApi).client
102102
resource, _ := client.GetResource(d.Id())
103103
d.Set("name", resource.Name)
104104
d.Set("type", resource.Type)
105105
return nil
106106
}
107107

108-
func resourceExampleSimpleCreate(d *schema.ResourceData, meta interface{}) error {
108+
func resourceExampleSimpleCreate(d *schema.ResourceData, meta any) error {
109109
client := meta.(*ProviderApi).client
110110
name := d.Get("name").(string)
111111
client.CreateResource(name)
@@ -161,7 +161,7 @@ func resourceExampleSimple() *schema.Resource {
161161
}
162162
}
163163

164-
func resourceExampleSimpleRead(d *schema.ResourceData, meta interface{}) error {
164+
func resourceExampleSimpleRead(d *schema.ResourceData, meta any) error {
165165
client := meta.(*ProviderApi).client
166166
resource, err := client.GetResource(d.Id())
167167
if err != nil {

‎website/docs/plugin/sdkv2/guides/terraform-0.12-compatibility.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ each time certain other attributes are updated, you can use
225225
to reflect that in the plan:
226226

227227
```go
228-
CustomizeDiff: customdiff.ComputedIf("version", func(d *schema.ResourceDiff, meta interface{}) bool {
228+
CustomizeDiff: customdiff.ComputedIf("version", func(d *schema.ResourceDiff, meta any) bool {
229229
return d.HasChange("content") || d.HasChange("content_type")
230230
})
231231
```

‎website/docs/plugin/sdkv2/guides/v2-upgrade-guide.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,8 @@ context-aware versions (`helper/schema.CreateContextFunc`,
113113
deprecated, and we recommend you upgrade to the context-aware versions to get
114114
their improvements, but the old versions will continue working for now.
115115
Upgrading involves changing your function signature from
116-
`func(*helper/schema.ResourceData, interface{}) error` to
117-
`func(context.Context, *helper/schema.ResourceData, interface{})
116+
`func(*helper/schema.ResourceData, any) error` to
117+
`func(context.Context, *helper/schema.ResourceData, any)
118118
diag.Diagnostics`. (We’ll talk about `diag.Diagnostics` in the next section.)
119119

120120
Not everything could have this backwards compatibility, however; some functions
@@ -141,7 +141,7 @@ This exposes diagnostics support when creating, reading, updating, deleting,
141141
and validating your resources.
142142

143143
```go
144-
func Create(ctx context.Context, *schema.ResourceData, meta interface{}) diag.Diagnostics {
144+
func Create(ctx context.Context, *schema.ResourceData, meta any) diag.Diagnostics {
145145
// do some stuff
146146
if err != nil {
147147
// this is the standard way to convert a Go error to Diagnostics

‎website/docs/plugin/sdkv2/logging/http-transport.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ func New() (*schema.Provider, error) {
3232
return &schema.Provider{
3333
// omitting the rest of the schema definition
3434

35-
ConfigureContextFunc: func (ctx context.Context, rsc *schema.ResourceData) (interface{}, diag.Diagnostics) {
35+
ConfigureContextFunc: func (ctx context.Context, rsc *schema.ResourceData) (any, diag.Diagnostics) {
3636

3737
// omitting provider-specific configuration logic
3838

‎website/docs/plugin/sdkv2/resources/customizing-differences.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func resourceExampleInstance() *schema.Resource {
3939
},
4040
},
4141
CustomizeDiff: customdiff.All(
42-
customdiff.ValidateChange("size", func (old, new, meta interface{}) error {
42+
customdiff.ValidateChange("size", func (old, new, meta any) error {
4343
// If we are increasing "size" then the new value must be
4444
// a multiple of the old value.
4545
if new.(int) <= old.(int) {
@@ -50,7 +50,7 @@ func resourceExampleInstance() *schema.Resource {
5050
}
5151
return nil
5252
}),
53-
customdiff.ForceNewIfChange("size", func (old, new, meta interface{}) bool {
53+
customdiff.ForceNewIfChange("size", func (old, new, meta any) bool {
5454
// "size" can only increase in-place, so we must create a new resource
5555
// if it is decreased.
5656
return new.(int) < old.(int)

‎website/docs/plugin/sdkv2/resources/import.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ func resourceExampleThing() *schema.Resource {
133133
return &schema.Resource{
134134
/* ... other Resource functions ... */
135135
Importer: &schema.ResourceImporter{
136-
State: func(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
136+
State: func(d *schema.ResourceData, meta any) ([]*schema.ResourceData, error) {
137137
// d.Id() here is the last argument passed to the `terraform import RESOURCE_TYPE.RESOURCE_NAME RESOURCE_ID` command
138138
// Here we use a function to parse the import ID (like the example above) to simplify our logic
139139
attribute1, attribute2, err := resourceServiceThingExampleThingParseId(d.Id())
@@ -200,7 +200,7 @@ The Terraform import framework supports importing multiple resources from a sing
200200
Given our fictitious example resource, if the API supported many associations with it, we could perform an API lookup during the resource import function to find those associations and add them to the Terraform state during import.
201201
202202
```go
203-
func resourceExampleThingImportState(d *schema.ResourceData, meta interface{}) ([]*schema.ResourceData, error) {
203+
func resourceExampleThingImportState(d *schema.ResourceData, meta any) ([]*schema.ResourceData, error) {
204204
// Perform API lookup using the import ID (d.Id()) and save those into a variable named associations
205205

206206
results := []*schema.ResourceData{d}

‎website/docs/plugin/sdkv2/resources/retries-and-customizable-timeouts.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The retry helper takes a timeout and a retry function.
8181
In the context of a `CREATE` function, once the backend responds with the desired state, invoke the `READ` function. If `READ` errors, return that error wrapped with `resource.NonRetryableError`. Otherwise, return `nil` (no error) from the retry function.
8282

8383
```go
84-
func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) error {
84+
func resourceExampleInstanceCreate(d *schema.ResourceData, meta any) error {
8585
name := d.Get("name").(string)
8686
client := meta.(*ExampleClient)
8787
resp, err := client.CreateInstance(name)
@@ -120,7 +120,7 @@ func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) err
120120
Use `resource.StateChangeConf` when your resource has multiple states to progress though, you require fine grained control of retry and delay timing, or you want to ensure a minimum number of occurrences of a target state is reached (this is very common when dealing with eventually consistent APIs, where a response can reply back with an old state between calls before becoming consistent).
121121

122122
```go
123-
func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) error {
123+
func resourceExampleInstanceCreate(d *schema.ResourceData, meta any) error {
124124
name := d.Get("name").(string)
125125
client := meta.(*ExampleClient)
126126
resp, err := client.CreateInstance(name)
@@ -135,7 +135,7 @@ func resourceExampleInstanceCreate(d *schema.ResourceData, meta interface{}) err
135135
Target: []string{
136136
client.ExampleInstanceStateCreateComplete,
137137
},
138-
Refresh: func() (interface{}, string, error) {
138+
Refresh: func() (any, string, error) {
139139
resp, err := client.DescribeInstance(name)
140140
if err != nil {
141141
0, "", err

0 commit comments

Comments
 (0)