Skip to content
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.

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

Jump to bottom

helper/schema: Clarify Schema type Deprecated field usage #1013

Merged
merged 1 commit into from Jul 28, 2022
Merged

helper/schema: Clarify Schema type Deprecated field usage #1013

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 26 additions & 5 deletions helper/schema/schema.go
View file
Open in desktop
Expand Up @@ -311,11 +311,32 @@ type Schema struct {
// "parent_block_name.0.child_attribute_name".
RequiredWith []string

// Deprecated indicates the message to include in a warning diagnostic to
// practitioners when this attribute is configured. Typically this is used
// to signal that this attribute will be removed in the future and provide
// next steps to the practitioner, such as using a different attribute,
// different resource, or if it should just be removed.
// Deprecated defines warning diagnostic details to display to
// practitioners configuring this attribute or block. The warning
// diagnostic summary is automatically set to "Argument is deprecated"
// along with configuration source file and line information.
//
// This warning diagnostic is only displayed during Terraform's validation
// phase when this field is a non-empty string, when the attribute is
// Required or Optional, and if the practitioner configuration attempts to
// set the attribute value to a known value. It cannot detect practitioner
// configuration values that are unknown ("known after apply").
//
// This field has no effect when the attribute is Computed-only (read-only;
// not Required or Optional) and a practitioner attempts to reference
// this attribute value in their configuration. There is a Terraform
// feature request to support this type of functionality:
//
// https://github.com/hashicorp/terraform/issues/7569
//
// Set this field to a practitioner actionable message such as:
//
// - "Configure other_attribute instead. This attribute will be removed
// in the next major version of the provider."
// - "Remove this attribute's configuration as it no longer is used and
// the attribute will be removed in the next major version of the
// provider."
//
Deprecated string

// ValidateFunc allows individual fields to define arbitrary validation
Expand Down
13 changes: 12 additions & 1 deletion website/docs/plugin/sdkv2/schemas/schema-methods.mdx
View file
Open in desktop
Expand Up @@ -132,11 +132,22 @@ ComputedWhen []string
// key.
ConflictsWith []string

// When Deprecated is set, this attribute is deprecated.
// When Deprecated is set, this attribute is deprecated and a warning
// diagnostic will automatically be raised when it is configured.
//
// A deprecated field still works, but will probably stop working in near
// future. This string is the message shown to the user with instructions on
// how to address the deprecation.
//
// This warning diagnostic is only displayed during Terraform's validation
// phase when the attribute is Required or Optional and if the practitioner
// configuration attempts to set the attribute value to a known value. It
// cannot detect practitioner configuration values that are unknown ("known
// after apply").
//
// This field has no effect when the attribute is Computed-only (read-only;
// not Required or Optional) and a practitioner attempts to reference
// this attribute value in their configuration.
Deprecated string

// When Removed is set, this attribute has been removed from the schema
Expand Down