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

Document default for proxied on cloudflare_record #2890

Closed
wants to merge 1 commit into from

Conversation

demon
Copy link

@demon demon commented Oct 27, 2023

This was originally requested in #4/fixed in b09befa, but was lost in the move to autogen docs (0813d55).

This was originally requested in cloudflare#4/fixed in b09befa, but
was lost in the move to autogen docs (0813d55).
@demon demon requested a review from jacobbednarz as a code owner October 27, 2023 00:17
@github-actions
Copy link
Contributor

Oops! It looks like no changelog entry is attached to this PR. Please include a release note as described in https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/contributing/changelog-process.md.

Example:

```release-note:TYPE
Release note
```

If you do not require a release note to be included and you have permission, please add the workflow/skip-changelog-entry label. Otherwise, a maintainer will add the label or ask you for one when they review the PR.

@jacobbednarz
Copy link
Member

jacobbednarz commented Oct 27, 2023

thanks for the PR! unfortunately, there is a little confusion here as the value from the schema does not default to false which is why this doesn't exist in the autogen'd docs (if it did, it would be automatically appended). the proxied field is not sent at all unless it is explicitly defined.

(the remote service may default to false however, that isn't generally something that ends up in the schema docs)

@demon
Copy link
Author

demon commented Oct 27, 2023

Ah, I see what you mean. I wonder if there's a way we can document this that makes sense as to the underlying behavior? When creating a record manually in your browser, the proxied field is checked by default (until you change record type to something that can't be proxied) -- so one could assume the Terraform provider would do the same barring docs to the contrary?

@jacobbednarz
Copy link
Member

jacobbednarz commented Oct 29, 2023

the provider mimics the API, not the UI. the reason is that the UI has different behaviour to account for some of the complexities in the APIs and commonly covers sharp edges for users.

so as is, this is already documented and the UI is the odd one out 😄

@demon demon closed this Oct 31, 2023
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.

2 participants