Expand on validation interfaces

Author: bbasata

resource/list.go

@@ -10,6 +10,14 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
 )
 
+// List represents an implementation of listing instances of a managed resource
+// This is the core interface for all list implementations.
+//
+// List implementations can optionally implement these additional concepts:
+//
+//   - Configure: Include provider-level data or clients.
+//   - Validation: Schema-based or entire configuration via
+//     ListWithConfigValidators or ListWithValidateConfig.
 type List interface {
 	Metadata(context.Context, MetadataRequest, *MetadataResponse)
 	ListSchema(context.Context, SchemaRequest, SchemaResponse)
@@ -21,6 +29,11 @@ type ListWithConfigure interface {
 	Configure(context.Context, ConfigureRequest, *ConfigureResponse)
 }
 
+type ListWithConfigValidators interface {
+	List
+	ListConfigValidators(context.Context) []ListConfigValidator
+}
+
 type ListWithValidateConfig interface {
 	List
 	ValidateListConfig(context.Context, ValidateListConfigRequest, *ValidateListConfigResponse)
@@ -42,10 +55,26 @@ type ListResult struct {
 	Diagnostics diag.Diagnostics
 }
 
+// ValidateListConfigRequest represents a request to validate the
+// configuration of a resource. An instance of this request struct is
+// supplied as an argument to the Resource ValidateListConfig receiver method
+// or automatically passed through to each ListConfigValidator.
 type ValidateListConfigRequest struct {
+	// Config is the configuration the user supplied for the resource.
+	//
+	// This configuration may contain unknown values if a user uses
+	// interpolation or other functionality that would prevent Terraform
+	// from knowing the value at request time.
 	Config tfsdk.Config
 }
 
+// ValidateListConfigResponse represents a response to a
+// ValidateListConfigRequest. An instance of this response struct is
+// supplied as an argument to the Resource ValidateListConfig receiver method
+// or automatically passed through to each ListConfigValidator.
 type ValidateListConfigResponse struct {
+	// Diagnostics report errors or warnings related to validating the resource
+	// configuration. An empty slice indicates success, with no warnings or
+	// errors generated.
 	Diagnostics diag.Diagnostics
 }

resource/list_test.go

@@ -12,11 +12,15 @@ import (
 type ComputeInstance struct {
 }
 
-func (c *ComputeInstance) Configure(_ context.Context, _ resource.ConfigureRequest, _ *resource.ConfigureResponse) {
-	panic("not implemented")
+type ComputeInstanceWithValidateConfig struct {
+	ComputeInstance
+}
+
+type ComputeInstanceWithConfigValidators struct {
+	ComputeInstance
 }
 
-func (c *ComputeInstance) ValidateListConfig(_ context.Context, _ resource.ValidateListConfigRequest, _ *resource.ValidateListConfigResponse) {
+func (c *ComputeInstance) Configure(_ context.Context, _ resource.ConfigureRequest, _ *resource.ConfigureResponse) {
 	panic("not implemented")
 }
 
@@ -52,12 +56,21 @@ func (c *ComputeInstance) Delete(_ context.Context, _ resource.DeleteRequest, _
 	panic("not implemented")
 }
 
-// ExampleResource_listable demonstrates a resource.Resource that implements resource.List interfaces
-func ExampleResource_listable() {
+func (c *ComputeInstanceWithValidateConfig) ValidateListConfig(_ context.Context, _ resource.ValidateListConfigRequest, _ *resource.ValidateListConfigResponse) {
+	panic("not implemented")
+}
+
+func (c *ComputeInstanceWithConfigValidators) ListConfigValidators(_ context.Context) []resource.ListConfigValidator {
+	panic("not implemented")
+}
 
+// ExampleResource_listable demonstrates a resource.Resource that implements
+// resource.List interfaces.
+func ExampleResource_listable() {
 	var _ resource.List = &ComputeInstance{}
 	var _ resource.ListWithConfigure = &ComputeInstance{}
-	var _ resource.ListWithValidateConfig = &ComputeInstance{}
+	var _ resource.ListWithValidateConfig = &ComputeInstanceWithValidateConfig{}
+	var _ resource.ListWithConfigValidators = &ComputeInstanceWithConfigValidators{}
 
 	var _ resource.Resource = &ComputeInstance{}
 	var _ resource.ResourceWithConfigure = &ComputeInstance{}