tfprotov5: Document Terraform CLI 0.12 through 0.14 requirement for U…

…pgradeResourceStateResponse.UpgradedState.Msgpack (#156) Reference: #155
hashicorp · Feb 17, 2022 · a939840 · a939840
1 parent a7b46e6
commit a939840
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tfprotov5/resource.go b/tfprotov5/resource.go
@@ -98,6 +98,9 @@ type UpgradeResourceStateResponse struct {
 	//
 	// The state should be represented as a tftypes.Object, with each
 	// attribute and nested block getting its own key and value.
+	//
+	// Terraform CLI 0.12 through 0.14 require the Msgpack field to be
+	// populated or an EOF error will be returned.
 	UpgradedState *DynamicValue
 
 	// Diagnostics report errors or warnings related to upgrading the