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

EphemeralWriteOnly: Initial support for MMv1 Generation in schema & docs #12550

Open
wants to merge 4 commits into
base: FEATURE-BRANCH-ephemeral-write-only
Choose a base branch
from

Conversation

BBBmau
Copy link
Collaborator

@BBBmau BBBmau commented Dec 12, 2024

Goal of this PR is to include WriteOnly property as part of generation to support the upcoming Ephemeral WriteOnly Attributes in Terraform 1.11

We add a new field titled write_only that includes WriteOnly in the schema of any field with write_only: true

Some things to know:

The generation will fail when write_only: true is set with any of the following:

  • sensitive (write_only attributes are meant to replace sensitive values in the future)
  • default_from_api/output set properties to be Computed + Optional which we do not support for ephemeral write-only attributes

It's also worth noting that flatteners are not needed as write-onlys will not be saved to state.

This PR also introduces WriteOnlyProperties that's needed to separate the Ephemeral Write-Only Attributes from a resource into it's own section when generation documentation (similar to how we have arguments and attributes. A new section will be introduced under the name Ephemeral Attributes Reference

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant