tidy

Author: bbasata

hats.go

@@ -0,0 +1,43 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package
+type ResourceWithList interface {
+	Resource
+
+	ListSchema(context.Context, SchemaRequest, SchemaResponse)
+	List(context.Context, ListRequest, ListResponse)
+}
+
+type ResourceWithValidateListConfig interface {
+	ResourceWithList
+
+	ValidateListConfig(
+		context.Context,
+		ValidateListConfigRequest,
+		ValidateListConfigResponse)
+}
+
+type ListRequest struct {
+	Config                tfsdk.Config
+	IncludeResourceObject bool
+}
+
+type ListResponse struct {
+	Results []ListResult
+}
+
+type ListResult struct {
+	Identity    tfsdk.ResourceIdentity
+	Resource    tfsdk.State
+	DisplayName string
+	Diagnostics diag.Diagnostics
+}
+
+type ValidateListConfigRequest struct {
+	Config tfsdk.Config
+}
+
+type ValidateListConfigResponse struct {
+	Diagnostics diag.Diagnostics
+}

internal/fwserver/server_getproviderschema.go

@@ -24,6 +24,7 @@ type GetProviderSchemaResponse struct {
 	ResourceSchemas          map[string]fwschema.Schema
 	DataSourceSchemas        map[string]fwschema.Schema
 	EphemeralResourceSchemas map[string]fwschema.Schema
+	ListSchemas              map[string]fwschema.Schema
 	FunctionDefinitions      map[string]function.Definition
 	Diagnostics              diag.Diagnostics
 }

resource/list.go

@@ -24,8 +24,8 @@ type List interface {
 	// such as examplecloud_thing..
 	Metadata(context.Context, MetadataRequest, *MetadataResponse)
 
-	// Schema should return the schema for list blocks.
-	ListSchema(context.Context, SchemaRequest, SchemaResponse)
+	// ListConfigSchema should return the schema for list blocks.
+	ListConfigSchema(context.Context, SchemaRequest, SchemaResponse)
 
 	// ListResources is called when the provider must list instances of a
 	// managed resource type that satisfy a user-provided request.
@@ -38,9 +38,7 @@ type List interface {
 type ListWithConfigure interface {
 	List
 
-	// Configure enables provider-level data or clients to be set in the
-	// provider-defined Resource type. It is separately executed for each
-	// ReadResource RPC.
+	// Configure enables provider-level data or clients to be set.
 	Configure(context.Context, ConfigureRequest, *ConfigureResponse)
 }
 
@@ -110,8 +108,18 @@ type ListResponse struct {
 // function implementation will emit zero or more results for a user-provided
 // request.
 type ListResult struct {
-	Identity    tfsdk.ResourceIdentity
-	Resource    tfsdk.ResourceObject
+	// Identity is the identity of the managed resource instance.
+	//
+	// A nil value will raise will raise a diagnostic.
+	Identity *tfsdk.ResourceIdentity
+
+	// ResourceObject is the provider's representation of all attributes of the
+	// managed resource instance.
+	//
+	// If ListRequest.IncludeResourceObject is true, a nil value will raise
+	// a warning diagnostic.
+	Resource *tfsdk.ResourceObject
+
 	DisplayName string
 	Diagnostics diag.Diagnostics
 }

resource/list_test.go

@@ -24,7 +24,7 @@ func (c *ComputeInstance) Configure(_ context.Context, _ resource.ConfigureReque
 	panic("not implemented")
 }
 
-func (c *ComputeInstance) ListSchema(_ context.Context, _ resource.SchemaRequest, _ resource.SchemaResponse) {
+func (c *ComputeInstance) ListConfigSchema(_ context.Context, _ resource.SchemaRequest, _ resource.SchemaResponse) {
 	panic("not implemented")
 }
 

resource/resource.go

@@ -75,7 +75,7 @@ type ResourceWithConfigure interface {
 
 // ResourceWithConfigValidators is an interface type that extends Resource to include declarative validations.
 //
-// Declaring validation using this methodology simplifies implmentation of
+// Declaring validation using this methodology simplifies implementation of
 // reusable functionality. These also include descriptions, which can be used
 // for automating documentation.
 //