docs: align docs for fields with SchemaConfigModeAttr #20428
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
radeksimko
force-pushed
the
docs-attr-as-block
branch
from
af7f6ba to
4c097d6
Compare
ewbankkit
removed
the
needs-triage
|
This functionality has been released in v3.53.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
This was referenced Aug 10, 2021
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fields which use
ConfigMode: schema.SchemaConfigModeAttrare generally treated as attributes by core. See https://github.com/hashicorp/terraform/blob/v1.0.3/internal/lang/blocktoattr/schema.go for more.Additionally it is proposed to deprecate blocks generally in providers in the long run as per hashicorp/terraform-plugin-framework#85
This documentation update reflects this plan and current reality by encouraging users to use the attribute notation.
I assume that some fields should probably be renamed to plural in the long run, but that seems like a job for another PR and more careful planning.