add a schemas method for list

Author: stephybun

internal/fwserver/server_listresources.go

@@ -85,9 +85,14 @@ func (s *Server) ListResourceFuncs(ctx context.Context) (map[string]func() list.
 			continue
 		}
 
+		schemasResp := list.SchemaResponse{}
+		if listResourceWithSchemas, ok := listResource.(list.ListResourceWithProtoSchemas); ok {
+			listResourceWithSchemas.Schemas(ctx, &schemasResp)
+		}
+
 		resourceFuncs, _ := s.ResourceFuncs(ctx)
 		if _, ok := resourceFuncs[typeName]; !ok {
-			if metadataResp.ProtoV5Schema == nil || metadataResp.ProtoV5IdentitySchema == nil {
+			if schemasResp.ProtoV5Schema == nil || schemasResp.ProtoV5IdentitySchema == nil {
 				s.listResourceFuncsDiags.AddError(
 					"ListResource Type Defined without a Matching Managed Resource Type",
 					fmt.Sprintf("The %s ListResource type name was returned, but no matching managed Resource type was defined. ", typeName)+

internal/proto5server/server_listresource.go

@@ -10,7 +10,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/fromproto5"
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwserver"
 	"github.com/hashicorp/terraform-plugin-framework/internal/toproto5"
-	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-framework/list"
 	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
 )
 
@@ -48,20 +48,22 @@ func (s *Server) ListResource(ctx context.Context, protoReq *tfprotov5.ListResou
 		return ListRequestErrorDiagnostics(ctx, allDiags...)
 	}
 
-	metadataResp := resource.MetadataResponse{}
-	listResource.Metadata(ctx, resource.MetadataRequest{}, &metadataResp)
-
 	req := &fwserver.ListRequest{
 		Config:          config,
 		ListResource:    listResource,
 		IncludeResource: protoReq.IncludeResource,
 		Limit:           protoReq.Limit,
 	}
 
+	schemaResp := list.SchemaResponse{}
+	if listResourceWithProtoSchemas, ok := listResource.(list.ListResourceWithProtoSchemas); ok {
+		listResourceWithProtoSchemas.Schemas(ctx, &schemaResp)
+	}
+
 	// There's validation in ListResources that ensures both are set if either is provided so it should be sufficient to only nil check Identity
-	if metadataResp.ProtoV5IdentitySchema != nil {
-		req.ResourceSchema, _ = fromproto5.ResourceSchema(ctx, metadataResp.ProtoV5Schema())
-		req.ResourceIdentitySchema, _ = fromproto5.IdentitySchema(ctx, metadataResp.ProtoV5IdentitySchema())
+	if schemaResp.ProtoV5IdentitySchema != nil {
+		req.ResourceSchema, _ = fromproto5.ResourceSchema(ctx, schemaResp.ProtoV5Schema())
+		req.ResourceIdentitySchema, _ = fromproto5.IdentitySchema(ctx, schemaResp.ProtoV5IdentitySchema())
 	} else {
 		req.ResourceSchema, diags = s.FrameworkServer.ResourceSchema(ctx, protoReq.TypeName)
 		allDiags.Append(diags...)

list/list_resource.go

@@ -11,6 +11,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
 	"github.com/hashicorp/terraform-plugin-framework/tfsdk"
+	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
 )
 
 // ListResource represents an implementation of listing instances of a managed resource
@@ -40,6 +41,16 @@ type ListResource interface {
 	List(context.Context, ListRequest, *ListResultsStream)
 }
 
+// ListResourceWithProtoSchemas is an interface type that extends ListResource to include a method
+// which allows provider developers to supply the ProtoV5 representations of resource and resource identity
+// schemas. This is necessary if list functionality is being used with a legacy resource.
+type ListResourceWithProtoSchemas interface {
+	ListResource
+
+	// Schemas is called to provide the ProtoV5 representations of the resource and resource identity schemas.
+	Schemas(context.Context, *SchemaResponse)
+}
+
 // ListResourceWithConfigure is an interface type that extends ListResource to include a method
 // which the framework will automatically call so provider developers have the
 // opportunity to setup any necessary provider-level data or clients.
@@ -175,6 +186,20 @@ type ListResult struct {
 	Diagnostics diag.Diagnostics
 }
 
+// SchemaResponse represents a response that is populated by the Schemas method
+// and is used to pass along the ProtoV5 representations of the resource and resource identity schemas.
+type SchemaResponse struct {
+	// ProtoV5IdentitySchema is the ProtoV5 representation of the resource identity
+	// schema. This should only be supplied if framework functionality is being used
+	// with a legacy resource. Currently, this only applies to list.
+	ProtoV5IdentitySchema func() *tfprotov5.ResourceIdentitySchema
+
+	// ProtoV5Schema is the ProtoV5 representation of the resource schema
+	// This should only be supplied if framework functionality is being used
+	// with a legacy resource. Currently, this only applies to list.
+	ProtoV5Schema func() *tfprotov5.Schema
+}
+
 // ValidateConfigRequest represents a request to validate the configuration of
 // a list resource. An instance of this request struct is supplied as an
 // argument to the [ListResourceWithValidateConfig.ValidateListResourceConfig]

resource/metadata.go

@@ -3,8 +3,6 @@
 
 package resource
 
-import "github.com/hashicorp/terraform-plugin-go/tfprotov5"
-
 // MetadataRequest represents a request for the Resource to return metadata,
 // such as its type name. An instance of this request struct is supplied as
 // an argument to the Resource type Metadata method.
@@ -27,16 +25,6 @@ type MetadataResponse struct {
 	// ResourceBehavior is used to control framework-specific logic when
 	// interacting with this resource.
 	ResourceBehavior ResourceBehavior
-
-	// ProtoV5IdentitySchema is the ProtoV5 representation of the resource identity
-	// schema. This should only be supplied if framework functionality is being used
-	// with a legacy resource. Currently, this only applies to list.
-	ProtoV5IdentitySchema func() *tfprotov5.ResourceIdentitySchema
-
-	// ProtoV5Schema is the ProtoV5 representation of the resource schema
-	// This should only be supplied if framework functionality is being used
-	// with a legacy resource. Currently, this only applies to list.
-	ProtoV5Schema func() *tfprotov5.Schema
 }
 
 // ResourceBehavior controls framework-specific logic when interacting