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

query_string include list makes wrong API call #4925

Closed
3 tasks done
devin-purple opened this issue Jan 22, 2025 · 3 comments
Closed
3 tasks done

query_string include list makes wrong API call #4925

devin-purple opened this issue Jan 22, 2025 · 3 comments
Labels
kind/bug Categorizes issue or PR as related to a bug. triage/needs-information Indicates an issue needs more information in order to work on it.

Comments

@devin-purple
Copy link

Confirmation

  • This is a bug with an existing resource and is not a feature request or enhancement. Feature requests should be submitted with Cloudflare Support or your account team.
  • I have searched the issue tracker and my issue isn't already found.
  • I have replicated my issue using the latest version of the provider and it is still present.

Terraform and Cloudflare provider version

OpenTofu v1.8.7
on linux_amd64

  • provider registry.opentofu.org/cloudflare/cloudflare v5.0.0-rc1

Affected resource(s)

cloudflare_ruleset

Terraform configuration files

resource "cloudflare_ruleset" "cache" {
  kind    = "zone"
  name    = "default"
  phase   = "http_request_cache_settings"
  zone_id = var.zone.id
  rules = [{
    action = "set_cache_settings"
    action_parameters = {
      cache = true
      cache_key = {
        custom_key = {
          query_string = {
            include = {
              list = ["one", "two", "three"]
            }
          }

[...]

Link to debug output

https://gist.github.com/devin-purple/03977db5c95a8eb07522a4dd1dff81de

Panic output

No response

Expected output

The provider is sending this as the API call

"query_string":{"include":{"list":["one","two","three"]}}}}

This seems incorrect, as it ends up looking like this in the UI (blank). When I query the API it also returns the same structure.

Image

When I configure the rule manually with the UI, querying the API comes back with this format - note the missing nested "list" parameter, and "include" is now an array and not an object.

              "query_string": {
                "include": [
                  "one",
                  "two",
                  "three"
                ]
              }

Actual output

query_string configuration is blank in UI

Steps to reproduce

  1. Run snippet
  2. Confirm blank in UI

Additional factoids

According to the documentation here, the structure of the block looks correct, with a nested "include" and "list" property.

https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/ruleset#nestedatt--rules--action_parameters--cache_key--custom_key--query_string

https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/ruleset#nestedatt--rules--action_parameters--cache_key--custom_key--query_string--include

The API documentation is the same: https://developers.cloudflare.com/api/resources/rulesets/subresources/rules/models/set_cache_settings_rule/#(schema)%20%3E%20(property)%20action_parameters%20%3E%20(property)%20cache

References

No response

@devin-purple devin-purple added kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 22, 2025
Copy link
Contributor

Community Note

Voting for Prioritization

  • Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

  • If you are interested in working on this issue, please leave a comment.
  • If this would be your first contribution, please review the contribution guide.

Copy link
Contributor

Thank you for reporting this issue! For maintainers to dig into issues it is required that all issues include the entirety of TF_LOG=DEBUG output to be provided. The only parts that should be redacted are your user credentials in the X-Auth-Key, X-Auth-Email and Authorization HTTP headers. Details such as zone or account identifiers are not considered sensitive but can be redacted if you are very cautious. This log file provides additional context from Terraform, the provider and the Cloudflare API that helps in debugging issues. Without it, maintainers are very limited in what they can do and may hamper diagnosis efforts.

This issue has been marked with triage/needs-information and is unlikely to receive maintainer attention until the log file is provided making this a complete bug report.

@github-actions github-actions bot added triage/needs-information Indicates an issue needs more information in order to work on it. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 22, 2025
@devin-purple
Copy link
Author

This is an issue with the Cloudflare UI. The cache behaves as expected despite not appearing correctly. I opened a ticket with Cloudflare support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug. triage/needs-information Indicates an issue needs more information in order to work on it.
Projects
None yet
Development

No branches or pull requests

1 participant