Block "data" argument: Clarify expected data format #257
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
Clarifies the expected data format for the "data" argument in the Block resource. The specific type is `schema.stringAttribute`, but we also set a CustomType of `jsontypes.NormalizedType`, which is an RFC 7159 JSON string. The Terraform Documentation tooling does not consider the CustomType field, so in the generated markdown it only say `String, Sensitive`. This can be confusing for users who expect to just pass any string here. So this change: - Clarifies the format expectations in the `data` argument description - Updates the examples to ensure we use `jsonencode` consistently Related to #255
mitchnielsen
had a problem deploying
to
Acceptance Tests
GitHub Actions
Failure
jamiezieziula
approved these changes
Sep 19, 2024
mitchnielsen
had a problem deploying
to
Acceptance Tests
GitHub Actions
Failure
mitchnielsen
had a problem deploying
to
Acceptance Tests
GitHub Actions
Failure
mitchnielsen
had a problem deploying
to
Acceptance Tests
GitHub Actions
Failure
mitchnielsen
had a problem deploying
to
Acceptance Tests
GitHub Actions
Failure
mitchnielsen
temporarily deployed
to
Acceptance Tests
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Clarifies the expected data format for the "data" argument in the Block resource.
The specific type is
schema.stringAttribute, but we also set a CustomType ofjsontypes.NormalizedType, which is an RFC 7159 JSON string.The Terraform Documentation tooling does not consider the CustomType field, so in the generated markdown it only say
String, Sensitive. This can be confusing for users who expect to just pass any string here.So this change:
dataargument descriptionjsonencodeconsistentlyRelated to #255