Add documentation for RequiredWith migration from SDKv2 to plugin framework

[remyleone]

Module version

...

Use-cases

Attempted Solutions

Proposal

References

[bflad]

Hi @remyleone 👋 Thank you for raising this. If you have any specific suggestions, please let us know.

There's currently the SDK to framework migration guide, but once it gets to individual schema.Schema fields, the documentation does split up a little bit depending on what you're trying to do. For example with RequiredWith, it is mentioned on this migration page: https://developer.hashicorp.com/terraform/plugin/framework/migrating/attributes-blocks/validators-predefined

But it doesn't say the exact solutions available for that particular field:

• If desired to leave the validation per-attribute, then it is implementing one of the type-specific AlsoRequires validators, such as https://pkg.go.dev/github.com/hashicorp/[email protected]/stringvalidator#AlsoRequires
• If desired to move the validation to be declared at the resource level, then it is implementing https://pkg.go.dev/github.com/hashicorp/[email protected]/resourcevalidator#RequiredTogether

@bendbennett do you think we should have https://developer.hashicorp.com/terraform/plugin/framework/migrating/attributes-blocks/fields and/or https://developer.hashicorp.com/terraform/plugin/framework/migrating/attributes-blocks/validators-predefined be a little bit more prescriptive about the mapping between the old and new? It may be useful to have tables, such as::

SDK Attribute Field	Framework Attribute Validator	Framework Resource Validator
ConflictsWith	{TYPE}validator.ConflictsWith()	resourcevalidator.Conflicting()

etc.

[remyleone]

It would be advantageous to have a table that lists each field and how you should translate it into the framework. I've been looking around many pages to see how I should try out to translate a given pattern. In particular, having a linter tool that offers automated suggestions/helps even if it is very simplistic would help give confidence that it could be achieved. While waiting for an automated tool to appear a table would be very much appreciated and offer great help to map possible migration.

[bendbennett]

@bflad I agree that more prescriptive mapping would be useful. To this end I've added an issue for Add more prescriptive documentation for mapping between SDKv2 and the Framework and opened a related PR for Documentation for mapping between SDKv2 and the Framework. I'm happy to expand on this further if additional more prescriptive documentation is useful or desired.

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.