Skip to content

Commit c199d46

Browse files
authored
tfprotov5+tfprotov6: Synchronize Protocol Buffers comments for ReadResource and UpgradeResourceState (#231)
Reference: hashicorp/terraform#31998
1 parent 368e57a commit c199d46

File tree

4 files changed

+68
-0
lines changed

4 files changed

+68
-0
lines changed

tfprotov5/internal/tfplugin5/tfplugin5.pb.go

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tfprotov5/internal/tfplugin5/tfplugin5.proto

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,15 @@ message PrepareProviderConfig {
183183
}
184184

185185
message UpgradeResourceState {
186+
// Request is the message that is sent to the provider during the
187+
// UpgradeResourceState RPC.
188+
//
189+
// This message intentionally does not include configuration data as any
190+
// configuration-based or configuration-conditional changes should occur
191+
// during the PlanResourceChange RPC. Additionally, the configuration is
192+
// not guaranteed to exist (in the case of resource destruction), be wholly
193+
// known, nor match the given prior state, which could lead to unexpected
194+
// provider behaviors for practitioners.
186195
message Request {
187196
string type_name = 1;
188197

@@ -240,6 +249,14 @@ message Configure {
240249
}
241250

242251
message ReadResource {
252+
// Request is the message that is sent to the provider during the
253+
// ReadResource RPC.
254+
//
255+
// This message intentionally does not include configuration data as any
256+
// configuration-based or configuration-conditional changes should occur
257+
// during the PlanResourceChange RPC. Additionally, the configuration is
258+
// not guaranteed to be wholly known nor match the given prior state, which
259+
// could lead to unexpected provider behaviors for practitioners.
243260
message Request {
244261
string type_name = 1;
245262
DynamicValue current_state = 2;

tfprotov6/internal/tfplugin6/tfplugin6.pb.go

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tfprotov6/internal/tfplugin6/tfplugin6.proto

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,15 @@ message ValidateProviderConfig {
201201
}
202202

203203
message UpgradeResourceState {
204+
// Request is the message that is sent to the provider during the
205+
// UpgradeResourceState RPC.
206+
//
207+
// This message intentionally does not include configuration data as any
208+
// configuration-based or configuration-conditional changes should occur
209+
// during the PlanResourceChange RPC. Additionally, the configuration is
210+
// not guaranteed to exist (in the case of resource destruction), be wholly
211+
// known, nor match the given prior state, which could lead to unexpected
212+
// provider behaviors for practitioners.
204213
message Request {
205214
string type_name = 1;
206215

@@ -258,6 +267,14 @@ message ConfigureProvider {
258267
}
259268

260269
message ReadResource {
270+
// Request is the message that is sent to the provider during the
271+
// ReadResource RPC.
272+
//
273+
// This message intentionally does not include configuration data as any
274+
// configuration-based or configuration-conditional changes should occur
275+
// during the PlanResourceChange RPC. Additionally, the configuration is
276+
// not guaranteed to be wholly known nor match the given prior state, which
277+
// could lead to unexpected provider behaviors for practitioners.
261278
message Request {
262279
string type_name = 1;
263280
DynamicValue current_state = 2;

0 commit comments

Comments
 (0)