tfprotov5+tfprotov6: Synchronize Protocol Buffers comments for ReadRe…

…source and UpgradeResourceState (#231) Reference: hashicorp/terraform#31998
hashicorp · Oct 14, 2022 · c199d46 · c199d46
1 parent 368e57a
commit c199d46
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 0 deletions.
diff --git a/tfprotov5/internal/tfplugin5/tfplugin5.pb.go b/tfprotov5/internal/tfplugin5/tfplugin5.pb.go
diff --git a/tfprotov5/internal/tfplugin5/tfplugin5.proto b/tfprotov5/internal/tfplugin5/tfplugin5.proto
@@ -183,6 +183,15 @@ message PrepareProviderConfig {
 }
 
 message UpgradeResourceState {
+    // Request is the message that is sent to the provider during the
+    // UpgradeResourceState RPC.
+    //
+    // This message intentionally does not include configuration data as any
+    // configuration-based or configuration-conditional changes should occur
+    // during the PlanResourceChange RPC. Additionally, the configuration is
+    // not guaranteed to exist (in the case of resource destruction), be wholly
+    // known, nor match the given prior state, which could lead to unexpected
+    // provider behaviors for practitioners.
     message Request {
         string type_name = 1;
 
@@ -240,6 +249,14 @@ message Configure {
 }
 
 message ReadResource {
+    // Request is the message that is sent to the provider during the
+    // ReadResource RPC.
+    //
+    // This message intentionally does not include configuration data as any
+    // configuration-based or configuration-conditional changes should occur
+    // during the PlanResourceChange RPC. Additionally, the configuration is
+    // not guaranteed to be wholly known nor match the given prior state, which
+    // could lead to unexpected provider behaviors for practitioners.
     message Request {
         string type_name = 1;
         DynamicValue current_state = 2;

diff --git a/tfprotov6/internal/tfplugin6/tfplugin6.pb.go b/tfprotov6/internal/tfplugin6/tfplugin6.pb.go
diff --git a/tfprotov6/internal/tfplugin6/tfplugin6.proto b/tfprotov6/internal/tfplugin6/tfplugin6.proto
@@ -201,6 +201,15 @@ message ValidateProviderConfig {
 }
 
 message UpgradeResourceState {
+    // Request is the message that is sent to the provider during the
+    // UpgradeResourceState RPC.
+    //
+    // This message intentionally does not include configuration data as any
+    // configuration-based or configuration-conditional changes should occur
+    // during the PlanResourceChange RPC. Additionally, the configuration is
+    // not guaranteed to exist (in the case of resource destruction), be wholly
+    // known, nor match the given prior state, which could lead to unexpected
+    // provider behaviors for practitioners.
     message Request {
         string type_name = 1;
 
@@ -258,6 +267,14 @@ message ConfigureProvider {
 }
 
 message ReadResource {
+    // Request is the message that is sent to the provider during the
+    // ReadResource RPC.
+    //
+    // This message intentionally does not include configuration data as any
+    // configuration-based or configuration-conditional changes should occur
+    // during the PlanResourceChange RPC. Additionally, the configuration is
+    // not guaranteed to be wholly known nor match the given prior state, which
+    // could lead to unexpected provider behaviors for practitioners.
     message Request {
         string type_name = 1;
         DynamicValue current_state = 2;