Skip to content

Commit eda2b7a

Browse files
authored
wip
1 parent b802e5c commit eda2b7a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/design/plan-modification.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The `PlanResourceChange` RPC response also contains a list of attribute paths: `
3737

3838
In allowing providers to control the `PlanResourceChange` response, i.e. "modify the plan", the plugin framework therefore enables providers not only to modify the diff that will be displayed to the user (and ultimately applied), but also to branch into a destroy-and-create lifecycle phase, triggering other RPCs.
3939

40-
Plan modification has two distinct use cases for providers:
40+
Plan modification currently has two distinct use cases for providers:
4141
- Modifying plan values, and
4242
- Forcing resource replacement.
4343

@@ -338,6 +338,8 @@ type ModifyAttributePlanResponse struct {
338338
}
339339
```
340340

341+
This approach directly offers documentation hooks, so that plan modification behaviours can be documented alongside their definition and included in generated schema docs.
342+
341343
In this case, `RequiresReplace` and `RequiresReplaceIf` can be implemented as `AttributePlanModifier`s, e.g.:
342344

343345

0 commit comments

Comments
 (0)