Skip to content

Add Callout for PreferWriteOnlyAttribute() validator in documentation #1105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 3, 2025
Merged

Add Callout for PreferWriteOnlyAttribute() validator in documentation #1105

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba8f825
Add callout for PreferWriteOnlyAttribute validators in the documentation
SBGoods Feb 27, 2025
5e7e5fd
Update wording
SBGoods Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions website/docs/plugin/framework/resources/write-only-arguments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ retrieving values from configuration.

## PreferWriteOnlyAttribute Validators

<Note>

These validators will produce persistent warnings for practitioners on every Terraform run as long as the specified non-write-only attribute
has a value in the configuration. The validators will also produce warnings for users of shared modules who cannot immediately take action on the warning.

</Note>

The `PreferWriteOnlyAttribute()` validators available in the [`terraform-plugin-framework-validators` Go module](https://pkg.go.dev/github.com/hashicorp/terraform-plugin-framework-validators)
can be used when you have a write-only version of an existing attribute, and you want to encourage practitioners to use the write-only version whenever possible.

Expand Down