Skip to content

Commit 49dcbe1

Browse files
committed
docs/design: Some additional context around current UpgradeResourceState implementation
1 parent 512cdf7 commit 49dcbe1

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/design/upgrade-resource-state.md

+7
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,13 @@ type Resource interface {
106106
}
107107
```
108108

109+
Since the underlying [`tfprotov6.ResourceServer`](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-go/tfprotov6#ResourceServer) interface requires an `UpgradeResourceState` implmentation, the framework currently implements a stub implementation that ensures:
110+
111+
- The resource type exists in this provider.
112+
- That given state in the request is passed back in the response (e.g. as a passthrough).
113+
114+
The implementation proposals are to handle schema versioning and allow provider developers to adjust the state between each version.
115+
109116
## Prior Implementations
110117

111118
### terraform-plugin-sdk

0 commit comments

Comments
 (0)