Add documentation about another type of Data Consistency Issue

[remyleone]

SDK version

github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0

Use-cases

I would like to see how to solve this kind of issue before migrating to the terraform framework. I stumble upon many of those issue and it is not clear to me how to solve it.

  | Error: Provider produced inconsistent result after apply
  | 
  | When applying changes to scaleway_job_definition.main, provider
  | "provider[\"registry.terraform.io/hashicorp/scaleway\"]" produced an
  | unexpected new value: .secret_reference: planned set element
  | cty.ObjectVal(map[string]cty.Value{"environment":cty.StringVal(""),
  | "file":cty.StringVal("/home/dev/env"),
  | "secret_id":cty.StringVal("fr-par/114ab44f-472d-4f07-81a9-c360f922889e"),
  | "secret_reference_id":cty.UnknownVal(cty.String),
  | "secret_version":cty.StringVal("latest")}) does not correlate with any
  | element in actual.
  | 
  | This is a bug in the provider, which should be reported in the provider's own
  | issue tracker.

Attempted Solutions

I could not add the flag in the schema that enable this kind of error.

Proposal

It would be helpful to add more documentation here https://developer.hashicorp.com/terraform/plugin/sdkv2/resources/data-consistency-errors#resolving-data-consistency-errors about how to solve this kind of problem

References

https://github.com/scaleway/terraform-provider-scaleway/pull/3282/files

https://github.com/scaleway/terraform-provider-scaleway/actions/runs/17243209011/job/48925885720?pr=3282#step:6:637

[SBGoods]

👋🏾 Hi @remyleone,
Sorry that you're running into trouble here. This error means that Terraform cannot match set elements between plan and apply because a planned element changed it's value during apply. This usually occurs with set nested blocks that have computed attributes where the API returns a value during apply, which changes the set element's identity. Our typically guidance for this is to move any computed attributes outside of set nested attributes or blocks or to consider migrating that attribute to a list nested block or attribute. For a more detailed answer, there's a useful discuss post on this topic.

This issue typically comes up during framework development, so we can consider adding documentation about this error in either the migration guide or the framework development documentation.