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

pulumi_gcp.organizations.Project has a new undocumented parameter deletion_policy #2739

Open
aaron-tillekeratne opened this issue Dec 15, 2024 · 1 comment
Labels
area/api-docs kind/bug Some behavior is incorrect or out of spec

Comments

@aaron-tillekeratne
Copy link

Describe what happened

Looks like pulumi_gcp.organizations.Project's deletion_policy parameter is undocumented.

See https://www.pulumi.com/registry/packages/gcp/api-docs/organizations/project/#state_deletion_policy_python

Sample program

import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.Project("foo", project_id="bar", deletion_policy="WHAT GOES HERE?")

Log output

No response

Affected Resource(s)

pulumi_gcp.organizations.Project

Output of pulumi about

Not required as this is documentation

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

@aaron-tillekeratne aaron-tillekeratne added kind/bug Some behavior is incorrect or out of spec needs-triage Needs attention from the triage team labels Dec 15, 2024
@guineveresaenger guineveresaenger removed the needs-triage Needs attention from the triage team label Dec 16, 2024
@guineveresaenger
Copy link
Contributor

guineveresaenger commented Dec 16, 2024

Hi @aaron-tillekeratne - thank you for making us aware of the missing documentation. We're sorry that you're running into these issues.

For quick reference, the constructor example shows the type of this field to be a string and according to the upstream documentation, possible values are: "PREVENT", "ABANDON", "DELETE". Default value is PREVENT.

Unfortunately, this is an example of a common limitation in our docs generator.

While we have workarounds, and may choose to employ one in this case, we're also in the situation where we need to reconsider our global approach. We'll update this issue as soon as we have a plan.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api-docs kind/bug Some behavior is incorrect or out of spec
Projects
None yet
Development

No branches or pull requests

2 participants